Available Add-ons Extensions Subresource
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.
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.
Property nameTypeRequiredDescriptionChild properties
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 The SID of the AvailableAddOn resource to which this extension applies.
Pattern: ^XB[0-9a-fA-F]{32}$Min length: 34Max length: 34
friendly_namestringOptional The string that you assigned to describe the resource.
product_namestringOptional The name of the Product this Extension is used within.
unique_namestringOptional An application-defined string that uniquely identifies the resource.
The absolute URL of the resource.
GET https://marketplace.twilio.com/v1/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}
Property nameTypeRequiredPIIDescription
AvailableAddOnSidSID<XB>required The SID of the AvailableAddOn resource with the extension to fetch.
Pattern: ^XB[0-9a-fA-F]{32}$Min length: 34Max length: 34
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.
_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19async function fetchAvailableAddOnExtension() {
_19 const extension = await client.marketplace.v1
_19 .availableAddOns("XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19 .extensions("XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19 console.log(extension.sid);
_19fetchAvailableAddOnExtension();
_10 "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "friendly_name": "Incoming Voice Call",
_10 "product_name": "Programmable Voice",
_10 "unique_name": "voice-incoming",
_10 "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
GET https://marketplace.twilio.com/v1/AvailableAddOns/{AvailableAddOnSid}/Extensions
Property nameTypeRequiredPIIDescription
AvailableAddOnSidSID<XB>required The SID of the AvailableAddOn resource with the extensions to read.
Pattern: ^XB[0-9a-fA-F]{32}$Min length: 34Max length: 34
Property nameTypeRequiredPIIDescription
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
This endpoint returns all Extensions associated with a given Available Add-on.
_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// 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);
_18async function listAvailableAddOnExtension() {
_18 const extensions = await client.marketplace.v1
_18 .availableAddOns("XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18 .extensions.list({ limit: 20 });
_18 extensions.forEach((e) => console.log(e.sid));
_18listAvailableAddOnExtension();
_21 "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_21 "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_21 "friendly_name": "Incoming Voice Call",
_21 "product_name": "Programmable Voice",
_21 "unique_name": "voice-incoming",
_21 "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_21 "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0",
_21 "previous_page_url": null,
_21 "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0",
_21 "next_page_url": null,