On this page

AvailableAddOns 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 AvailableAddOns resource provides detailed descriptions of the Add-on Listings currently available to be installed by an Account.

The AvailableAddOns resource allows you to read a list of all available Add-on Listings or to fetch a specific Add-on Listing's detailed description.

(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.

AvailableAddOn Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<XB>Optional

Not PII

The unique string that we created to identify the AvailableAddOn resource.

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

friendly_namestringOptional

Not PII

The string that you assigned to describe the resource.

descriptionstringOptional

Not PII

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

pricing_typestringOptional

Not PII

How customers are charged for using this Add-on.

configuration_schemaobjectOptional

Not PII

The JSON object with the configuration that must be provided when installing a given Add-on.

urlstring<uri>Optional

Not PII

The absolute URL of the resource.

linksobject<uri-map>Optional

Not PII

The URLs of related resources.

Fetch a single AvailableAddOn resource by SID

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

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<XB>required

Not PII

The SID of the AvailableAddOn resource to fetch.

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

Fetch an AvailableAddOn

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 fetchAvailableAddOn() {
11  const availableAddOn = await client.marketplace.v1
12    .availableAddOns("XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(availableAddOn.sid);
16}
17
18fetchAvailableAddOn();

Output

1{
2  "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "friendly_name": "VoiceBase High Accuracy Transcription",
4  "description": "Automatic Transcription and Keyword Extract...",
5  "pricing_type": "per minute",
6  "configuration_schema": {
7    "type": "object",
8    "properties": {
9      "bad_words": {
10        "type": "boolean"
11      }
12    },
13    "required": [
14      "bad_words"
15    ]
16  },
17  "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18  "links": {
19    "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions"
20  }
21}

List all AvailableAddOn resources

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

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

Not PII

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

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

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

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

List multiple AvailableAddOns

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 listAvailableAddOn() {
11  const availableAddOns = await client.marketplace.v1.availableAddOns.list({
12    limit: 20,
13  });
14
15  availableAddOns.forEach((a) => console.log(a.sid));
16}
17
18listAvailableAddOn();

Output

1{
2  "available_add_ons": [
3    {
4      "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "friendly_name": "VoiceBase High Accuracy Transcription",
6      "description": "Automatic Transcription and Keyword Extract...",
7      "pricing_type": "per minute",
8      "configuration_schema": {
9        "type": "object",
10        "properties": {
11          "bad_words": {
12            "type": "boolean"
13          }
14        },
15        "required": [
16          "bad_words"
17        ]
18      },
19      "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
20      "links": {
21        "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions"
22      }
23    }
24  ],
25  "meta": {
26    "page": 0,
27    "page_size": 50,
28    "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
29    "previous_page_url": null,
30    "url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
31    "next_page_url": null,
32    "key": "available_add_ons"
33  }
34}