On this page

InstalledAddOns Resource

(warning)

Migrate from Preview to v1

Marketplace v1 API is now available, and the Preview API for this Resource will be discontinued in December 2024. See the API Preview to v1 Migration Guide for more information.

The InstalledAddOns resource allows you to install, configure, and manage installed Add-on Listings for an Account. Multiple instances of an Add-on Listing can be installed on an Account, each with a different configuration.

(information)

Info

This API only supports Add-on Listings that are in General Availability (GA) or Beta state. Listings that are labeled as Coming Soon or Developer Preview are not accessible via the API and must be managed in the Console.

InstalledAddOn Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<XE>Optional

The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'.

Pattern: ^XE[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>Optional

The SID of the Account that created the InstalledAddOn resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendly_namestringOptional

The string that you assigned to describe the resource.

descriptionstringOptional

A short description of the Add-on's functionality.

configurationobjectOptional

The JSON object that represents the current configuration of installed Add-on.

unique_namestringOptional

An application-defined string that uniquely identifies the resource.

date_createdstring<date-time>Optional

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring<date-time>Optional

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring<uri>Optional

The absolute URL of the resource.

linksobject<uri-map>Optional

The URLs of related resources.

Install an Add-on Listing

POST https://marketplace.twilio.com/v1/InstalledAddOns

To install an Add-on Listing within your Account, you need to find its AvailableAddOn SID. You can do this by listing all AvailableAddOn resources and finding the SID of the one you wish to install. The AvailableAddOn resource also shows the information required for installing the Add-on Listing.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

AvailableAddOnSidSID<XB>required

The SID of the AvaliableAddOn to install.

Pattern: ^XB[0-9a-fA-F]{32}$Min length: 34Max length: 34

AcceptTermsOfServicebooleanrequired

Whether the Terms of Service were accepted.

ConfigurationobjectOptional

The JSON object that represents the configuration of the new Add-on being installed.

UniqueNamestringOptional

An application-defined string that uniquely identifies the resource. This value must be unique within the Account.

Install an available Add-on

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createInstalledAddOn() {
11  const installedAddOn = await client.marketplace.v1.installedAddOns.create({
12    acceptTermsOfService: true,
13    availableAddOnSid: "XB85b56ed9ce713e0ac62342b901233193",
14    configuration: {
15      callback_method: "POST",
16      callback_url: "https://example.com/your-callback-url",
17      "include-keywords": true,
18      "include-topics": true,
19    },
20  });
21
22  console.log(installedAddOn.sid);
23}
24
25createInstalledAddOn();

Output

1{
2  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "VoiceBase High Accuracy Transcription",
5  "description": "Automatic Transcription and Keyword Extract...",
6  "configuration": {
7    "bad_words": true
8  },
9  "unique_name": "voicebase_high_accuracy_transcription_1",
10  "date_created": "2016-04-07T23:52:28Z",
11  "date_updated": "2016-04-07T23:52:28Z",
12  "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
15    "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
16  }
17}

Fetch an instance of an Add-on currently installed on this Account.

GET https://marketplace.twilio.com/v1/InstalledAddOns/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<XE>required

The SID of the InstalledAddOn resource to fetch.

Pattern: ^XE[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch an InstalledAddOn

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchInstalledAddOn() {
11  const installedAddOn = await client.marketplace.v1
12    .installedAddOns("XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(installedAddOn.sid);
16}
17
18fetchInstalledAddOn();

Output

1{
2  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "VoiceBase High Accuracy Transcription",
5  "description": "Automatic Transcription and Keyword Extract...",
6  "configuration": {
7    "bad_words": true
8  },
9  "unique_name": "voicebase_high_accuracy_transcription",
10  "date_created": "2016-04-07T23:52:28Z",
11  "date_updated": "2016-04-07T23:52:28Z",
12  "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
15    "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
16  }
17}

Retrieve a list of Add-ons currently installed on this Account.

GET https://marketplace.twilio.com/v1/InstalledAddOns

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

List multiple InstalledAddOns

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listInstalledAddOn() {
11  const installedAddOns = await client.marketplace.v1.installedAddOns.list({
12    limit: 20,
13  });
14
15  installedAddOns.forEach((i) => console.log(i.sid));
16}
17
18listInstalledAddOn();

Output

1{
2  "installed_add_ons": [
3    {
4      "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "friendly_name": "VoiceBase High Accuracy Transcription",
7      "description": "Automatic Transcription and Keyword Extract...",
8      "configuration": {
9        "bad_words": true
10      },
11      "unique_name": "voicebase_high_accuracy_transcription",
12      "date_created": "2016-04-07T23:52:28Z",
13      "date_updated": "2016-04-07T23:52:28Z",
14      "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15      "links": {
16        "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
17        "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
18      }
19    }
20  ],
21  "meta": {
22    "page": 0,
23    "page_size": 50,
24    "first_page_url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0",
25    "previous_page_url": null,
26    "url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0",
27    "next_page_url": null,
28    "key": "installed_add_ons"
29  }
30}

Update an Add-on installation for the Account specified.

POST https://marketplace.twilio.com/v1/InstalledAddOns/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<XE>required

The SID of the InstalledAddOn resource to update.

Pattern: ^XE[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

ConfigurationobjectOptional

Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured

UniqueNamestringOptional

An application-defined string that uniquely identifies the resource. This value must be unique within the Account.

Update an InstalledAddOn

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateInstalledAddOn() {
11  const installedAddOn = await client.marketplace.v1
12    .installedAddOns("XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .update({ configuration: {} });
14
15  console.log(installedAddOn.sid);
16}
17
18updateInstalledAddOn();

Output

1{
2  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "VoiceBase High Accuracy Transcription",
5  "description": "Automatic Transcription and Keyword Extract...",
6  "configuration": {
7    "bad_words": true
8  },
9  "unique_name": "voicebase_high_accuracy_transcription_2",
10  "date_created": "2016-04-07T23:52:28Z",
11  "date_updated": "2016-04-07T23:52:28Z",
12  "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
15    "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
16  }
17}

Remove an Add-on installation from your account

DELETE https://marketplace.twilio.com/v1/InstalledAddOns/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<XE>required

The SID of the InstalledAddOn resource to delete.

Pattern: ^XE[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete an InstalledAddOn

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteInstalledAddOn() {
11  await client.marketplace.v1
12    .installedAddOns("XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .remove();
14}
15
16deleteInstalledAddOn();