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

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.

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.

Install an available Add-on

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_25// Download the helper library from https://www.twilio.com/docs/node/install
_25const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_25
_25// Find your Account SID and Auth Token at twilio.com/console
_25// and set the environment variables. See http://twil.io/secure
_25const accountSid = process.env.TWILIO_ACCOUNT_SID;
_25const authToken = process.env.TWILIO_AUTH_TOKEN;
_25const client = twilio(accountSid, authToken);
_25
_25async function createInstalledAddOn() {
_25  const installedAddOn = await client.marketplace.v1.installedAddOns.create({
_25    acceptTermsOfService: true,
_25    availableAddOnSid: "XB85b56ed9ce713e0ac62342b901233193",
_25    configuration: {
_25      callback_method: "POST",
_25      callback_url: "https://example.com/your-callback-url",
_25      "include-keywords": true,
_25      "include-topics": true,
_25    },
_25  });
_25
_25  console.log(installedAddOn.sid);
_25}
_25
_25createInstalledAddOn();

Output


_17{
_17  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "friendly_name": "VoiceBase High Accuracy Transcription",
_17  "description": "Automatic Transcription and Keyword Extract...",
_17  "configuration": {
_17    "bad_words": true
_17  },
_17  "unique_name": "voicebase_high_accuracy_transcription_1",
_17  "date_created": "2016-04-07T23:52:28Z",
_17  "date_updated": "2016-04-07T23:52:28Z",
_17  "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "links": {
_17    "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
_17    "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_17  }
_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

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function fetchInstalledAddOn() {
_18  const installedAddOn = await client.marketplace.v1
_18    .installedAddOns("XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .fetch();
_18
_18  console.log(installedAddOn.sid);
_18}
_18
_18fetchInstalledAddOn();

Output


_17{
_17  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "friendly_name": "VoiceBase High Accuracy Transcription",
_17  "description": "Automatic Transcription and Keyword Extract...",
_17  "configuration": {
_17    "bad_words": true
_17  },
_17  "unique_name": "voicebase_high_accuracy_transcription",
_17  "date_created": "2016-04-07T23:52:28Z",
_17  "date_updated": "2016-04-07T23:52:28Z",
_17  "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "links": {
_17    "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
_17    "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_17  }
_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

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function listInstalledAddOn() {
_18  const installedAddOns = await client.marketplace.v1.installedAddOns.list({
_18    limit: 20,
_18  });
_18
_18  installedAddOns.forEach((i) => console.log(i.sid));
_18}
_18
_18listInstalledAddOn();

Output


_30{
_30  "installed_add_ons": [
_30    {
_30      "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_30      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_30      "friendly_name": "VoiceBase High Accuracy Transcription",
_30      "description": "Automatic Transcription and Keyword Extract...",
_30      "configuration": {
_30        "bad_words": true
_30      },
_30      "unique_name": "voicebase_high_accuracy_transcription",
_30      "date_created": "2016-04-07T23:52:28Z",
_30      "date_updated": "2016-04-07T23:52:28Z",
_30      "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_30      "links": {
_30        "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
_30        "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_30      }
_30    }
_30  ],
_30  "meta": {
_30    "page": 0,
_30    "page_size": 50,
_30    "first_page_url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0",
_30    "previous_page_url": null,
_30    "url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0",
_30    "next_page_url": null,
_30    "key": "installed_add_ons"
_30  }
_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

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function updateInstalledAddOn() {
_18  const installedAddOn = await client.marketplace.v1
_18    .installedAddOns("XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .update({ configuration: {} });
_18
_18  console.log(installedAddOn.sid);
_18}
_18
_18updateInstalledAddOn();

Output


_17{
_17  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "friendly_name": "VoiceBase High Accuracy Transcription",
_17  "description": "Automatic Transcription and Keyword Extract...",
_17  "configuration": {
_17    "bad_words": true
_17  },
_17  "unique_name": "voicebase_high_accuracy_transcription_2",
_17  "date_created": "2016-04-07T23:52:28Z",
_17  "date_updated": "2016-04-07T23:52:28Z",
_17  "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17  "links": {
_17    "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
_17    "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_17  }
_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

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function deleteInstalledAddOn() {
_16  await client.marketplace.v1
_16    .installedAddOns("XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_16    .remove();
_16}
_16
_16deleteInstalledAddOn();