On this page

Available Add-ons Extensions Subresource

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

This subresource of the Available Add-ons resource allows users to fetch an Extension or view a list of Extensions associated with an Available Add-on Listing. An Extension describes the specific feature or API endpoint of a Twilio product in which an Add-on Listing can be used.

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

Extension Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<XF>

Optional

Not PII

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

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

available_add_on_sidSID<XB>

Optional

Not PII

The SID of the AvailableAddOn resource to which this extension applies.

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

friendly_namestring

Optional

Not PII

The string that you assigned to describe the resource.

product_namestring

Optional

Not PII

The name of the Product this Extension is used within.

unique_namestring

Optional

Not PII

An application-defined string that uniquely identifies the resource.

urlstring<uri>

Optional

Not PII

The absolute URL of the resource.

Fetch an instance of an Extension for the Available Add-on.

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

Path parameters

Property nameTypeRequiredPIIDescription

AvailableAddOnSidSID<XB>required

Not PII

The SID of the AvailableAddOn resource with the extension to fetch.

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

SidSID<XF>required

Not PII

The SID of the AvailableAddOn Extension resource to fetch.

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

This endpoint returns details on a given Extension associated with a given Available Add-on.

Fetch an Extension

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

Output

1{
2  "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Incoming Voice Call",
5  "product_name": "Programmable Voice",
6  "unique_name": "voice-incoming",
7  "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
8}

Retrieve a list of Extensions for the Available Add-on.

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

Path parameters

Property nameTypeRequiredPIIDescription

AvailableAddOnSidSID<XB>required

Not PII

The SID of the AvailableAddOn resource with the extensions to read.

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

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeinteger

Optional

Not PII

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

Minimum: 1Maximum: 1000

Pageinteger

Optional

Not PII

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

Minimum: 0

PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

This endpoint returns all Extensions associated with a given Available Add-on.

List multiple Extensions

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

Output

1{
2  "extensions": [
3    {
4      "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "friendly_name": "Incoming Voice Call",
7      "product_name": "Programmable Voice",
8      "unique_name": "voice-incoming",
9      "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
10    }
11  ],
12  "meta": {
13    "page": 0,
14    "page_size": 50,
15    "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0",
16    "previous_page_url": null,
17    "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0",
18    "next_page_url": null,
19    "key": "extensions"
20  }
21}