Add-on Management API
This guide describes the APIs you can use to retrieve available and installed Add-ons. You can also use it to install specific Add-ons, and to manage any extensions they have. This API complements the Add-on capabilities exposed in the Console.
This API is currently in Developer Preview.
Info
The Add-on Management API only supports Add-ons that are in General Availability (GA) or Beta state. Add-ons that are labeled as Coming Soon or Developer Preview are not accessible via the API and must be managed in the Console.
While this API is in Developer Preview, it should be accessed via the following base domain:
_10https://preview.twilio.com
The API may also be accessed via Next-gen helper libraries.
The Available Add-ons API provides detailed descriptions of the Add-ons currently available to be installed by an Account. This API does not allow you to mutate any of the records.
_10/marketplace/AvailableAddOns
_10/marketplace/AvailableAddOns/{AddOnSid}
Resource properties
sid
type: SID<XB>
The unique string that we created to identify the AvailableAddOn resource.
Pattern:
^XB[0-9a-fA-F]{32}$
friendly_name
type: string
The string that you assigned to describe the resource.
description
type: string
A short description of the Add-on's functionality.
pricing_type
type: string
How customers are charged for using this Add-on.
configuration_schema
type: object
The JSON object with the configuration that must be provided when installing a given Add-on.
url
type: string<uri>
The absolute URL of the resource.
links
type: object<uri-map>
The URLs of related resources.
Returns a list of Available Add-on resources.
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.preview.marketplace
_11 .then(availableAddOns => availableAddOns.forEach(a => console.log(a.friendlyName)));
_34 "available_add_ons": [
_34 "sid": "XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34 "friendly_name": "VoiceBase High Accuracy Transcription",
_34 "description": "Automatic Transcription and Keyword Extract...",
_34 "pricing_type": "per minute",
_34 "configuration_schema": {
_34 "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34 "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions"
_34 "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0",
_34 "previous_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0",
_34 "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0",
_34 "next_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=1",
_34 "key": "available_add_ons"
Returns a single instance of an Available Add-on resource.
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.preview.marketplace
_11 .availableAddOns('XB85b56ed9ce713e0ac62342b901233193')
_11 .then(available_add_on => console.log(available_add_on.friendlyName));
_21 "sid": "XB85b56ed9ce713e0ac62342b901233193",
_21 "friendly_name": "VoiceBase High Accuracy Transcription",
_21 "description": "Automatic Transcription and Keyword Extract...",
_21 "pricing_type": "per minute",
_21 "configuration_schema": {
_21 "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions"
The Available Add-on Extension subresource details where a given Available Add-on can be invoked.
_10/marketplace/AvailableAddOns/{AddOnSid}/Extensions
Resource properties
sid
type: SID<XF>
The unique string that we created to identify the AvailableAddOnExtension resource.
Pattern:
^XF[0-9a-fA-F]{32}$
available_add_on_sid
type: SID<XB>
The SID of the AvailableAddOn resource to which this extension applies.
Pattern:
^XB[0-9a-fA-F]{32}$
friendly_name
type: string
The string that you assigned to describe the resource.
product_name
type: string
The name of the Product this Extension is used within.
unique_name
type: string
An application-defined string that uniquely identifies the resource.
url
type: string<uri>
The absolute URL of the resource.
Returns a list of Extension resources that detail the invocation points for the Available Add-on.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.preview.marketplace
_12 .availableAddOns('XB85b56ed9ce713e0ac62342b901233193')
_12 .then(extensions => extensions.forEach(e => console.log(e.sid)));
_21 "sid": "XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "available_add_on_sid": "XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "friendly_name": "Incoming Voice Call",
_21 "product_name": "Programmable Voice",
_21 "unique_name": "voice-incoming",
_21 "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions/XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_21 "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions?PageSize=50&Page=0",
_21 "previous_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions?PageSize=50&Page=0",
_21 "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions?PageSize=50&Page=0",
_21 "next_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions?PageSize=50&Page=1",
The Installed Add-ons API allows you to install, configure, and manage Add-ons for an account. An Add-on may be installed multiple times on a given account, each with a different Add-on configuration. Upon installation, the Add-on is identified by an AddOnConfigurationSid
property.
_10/marketplace/InstalledAddOns
_10/marketplace/InstalledAddOns/{AddOnConfigurationSid}
Resource properties
sid
type: SID<XE>
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}$
friendly_name
type: string
The string that you assigned to describe the resource.
description
type: string
A short description of the Add-on's functionality.
configuration
type: object
The JSON object that represents the current configuration of installed Add-on.
unique_name
type: string
An application-defined string that uniquely identifies the resource.
date_created
type: string<date-time>
date_updated
type: string<date-time>
url
type: string<uri>
The absolute URL of the resource.
links
type: object<uri-map>
The URLs of related resources.
Returns a list of Installed Add-ons associated with the given account.
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.preview.marketplace
_11 .then(installedAddOns => installedAddOns.forEach(i => console.log(i.friendlyName)));
_30 "installed_add_ons": [
_30 "sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_30 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_30 "friendly_name": "VoiceBase High Accuracy Transcription",
_30 "description": "Automatic Transcription and Keyword Extract...",
_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://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_30 "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions",
_30 "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_30 "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0",
_30 "previous_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0",
_30 "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0",
_30 "next_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=1",
_30 "key": "installed_add_ons"
Returns a single instance of an Installed Add-on associated with the given account.
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.preview.marketplace
_11 .installedAddOns('XB85b56ed9ce713e0ac62342b901233193')
_11 .then(installed_add_on => console.log(installed_add_on.friendlyName));
_17 "sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "friendly_name": "VoiceBase High Accuracy Transcription",
_17 "description": "Automatic Transcription and Keyword Extract...",
_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://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions",
_17 "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
Allows you to install an Available Add-on to the account.
Request body parameters
AvailableAddOnSid
type: SID<XB>Required
The SID of the AvaliableAddOn to install.
Pattern:
^XB[0-9a-fA-F]{32}$
AcceptTermsOfService
type: booleanRequired
Whether the Terms of Service were accepted.
Configuration
type: object
The JSON object that represents the configuration of the new Add-on being installed.
UniqueName
type: string
An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
_20// Download the helper library from https://www.twilio.com/docs/node/install
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = require('twilio')(accountSid, authToken);
_20client.preview.marketplace
_20 callback_method: 'POST',
_20 callback_url: 'https://your.callback.url',
_20 include-keywords: true,
_20 availableAddOnSid: 'XB85b56ed9ce713e0ac62342b901233193',
_20 acceptTermsOfService: true
_20 .then(installed_add_on => console.log(installed_add_on.friendlyName));
_20 "sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "friendly_name": "VoiceBase High Accuracy Transcription",
_20 "description": "Automatic Transcription and Keyword Extract...",
_20 "callback_method": "POST",
_20 "callback_url": "https://your.callback.url",
_20 "include-keywords": true,
_20 "include-topics": true
_20 "unique_name": "voicebase_high_accuracy_transcription_1",
_20 "date_created": "2016-04-07T23:52:28Z",
_20 "date_updated": "2016-04-07T23:52:28Z",
_20 "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions",
_20 "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
Allows you to update an Installed Add-on's configuration by supplying a JSON object that uses the schema exposed by the Available Add-on.
URI parameters
Sid
type: SID<XE>
The SID of the InstalledAddOn resource to update.
Pattern:
^XE[0-9a-fA-F]{32}$
Request body parameters
Configuration
type: object
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
UniqueName
type: string
An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
_16// Download the helper library from https://www.twilio.com/docs/node/install
_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 = require('twilio')(accountSid, authToken);
_16client.preview.marketplace
_16 .installedAddOns('XB85b56ed9ce713e0ac62342b901233193')
_16 .update({configuration: {
_16 callback_method: 'POST',
_16 callback_url: 'https://your.callback.url',
_16 include-keywords: true,
_16 .then(installed_add_on => console.log(installed_add_on.configuration));
_20 "sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "friendly_name": "VoiceBase High Accuracy Transcription",
_20 "description": "Automatic Transcription and Keyword Extract...",
_20 "callback_method": "POST",
_20 "callback_url": "https://your.callback.url",
_20 "include-keywords": true,
_20 "include-topics": true
_20 "unique_name": "voicebase_high_accuracy_transcription_2",
_20 "date_created": "2016-04-07T23:52:28Z",
_20 "date_updated": "2016-04-07T23:52:28Z",
_20 "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions",
_20 "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
Uninstalls the Add-on from the account. If the Add-on is currently assigned to an Incoming Phone Number, the API will return a 400 error to inform the user that they must first remove the assignment. Successful responses will return no content.
An Extension identifies a Twilio product, or an integration point in a Twilio product, where the Add-on is invoked. Examples of Extensions include Record Verb, Dial Verb, the Lookup API, Incoming Voice Call, Incoming SMS, etc.
The Installed Add-on Extensions API provides you with the ability to view and configure when an Installed Add-on is invoked.
To allow you to control the roll-out of Add-ons, by default all Extensions will be disabled. This means you will need to make additional API requests to enable Extensions before they can use the installed Add-on. This will give you the opportunity to first associate an Installed Add-on with an Incoming Phone Number before enabling any Extensions.
The following table lists the currently supported Extensions. Each Add-on typically supports a subset of these Extensions.
Product Name | Friendly Name | Unique Name |
---|
Lookup | Lookups | lookup-api |
Programmable SMS | Incoming SMS Message | sms-incoming |
TaskRouter | Create TaskRouter Tasks | taskrouter-create-task |
Programmable Voice | Incoming Voice Call | voice-incoming |
Programmable Voice | Record Verb Recordings | recording-verb |
Programmable Voice | Outgoing Call (API) Recordings | recording-api |
Programmable Voice | Conference Recordings | recording-conference |
Programmable Voice | Dial Verb Recordings | recording-dial |
_10/marketplace/InstalledAddOns/{AddOnConfigurationSid}/Extensions
_10/marketplace/InstalledAddOns/{AddOnConfigurationSid}/Extensions/{AddOnExtensionSid}
Resource properties
sid
type: SID<XF>
The unique string that we created to identify the InstalledAddOn Extension resource.
Pattern:
^XF[0-9a-fA-F]{32}$
installed_add_on_sid
type: SID<XE>
The SID of the InstalledAddOn resource to which this extension applies.
Pattern:
^XE[0-9a-fA-F]{32}$
friendly_name
type: string
The string that you assigned to describe the resource.
product_name
type: string
The name of the Product this Extension is used within.
unique_name
type: string
An application-defined string that uniquely identifies the resource.
enabled
type: boolean
Whether the Extension will be invoked.
url
type: string<uri>
The absolute URL of the resource.
Returns a list of Extensions where the Add-on can be invoked.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.preview.marketplace
_12 .installedAddOns('XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(extensions => extensions.forEach(e => console.log(e.enabled)));
_22 "sid": "XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22 "installed_add_on_sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22 "friendly_name": "Incoming Voice Call",
_22 "product_name": "Programmable Voice",
_22 "unique_name": "voice-incoming",
_22 "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions/XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_22 "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions?PageSize=50&Page=0",
_22 "previous_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions?PageSize=50&Page=0",
_22 "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions?PageSize=50&Page=0",
_22 "next_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions?PageSize=50&Page=1",
Returns a single instance of an Add-on Extension resource.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.preview.marketplace
_12 .installedAddOns('XB85b56ed9ce713e0ac62342b901233193')
_12 .extensions('XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(installed_add_on_extension => console.log(installed_add_on_extension.enabled));
_10 "sid": "XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "installed_add_on_sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "friendly_name": "Incoming Voice Call",
_10 "product_name": "Programmable Voice",
_10 "unique_name": "voice-incoming",
_10 "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions/XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
Allows you to activate or deactivate an Extension associated with the Installed Add-on.
URI parameters
InstalledAddOnSid
type: SID<XE>
The SID of the InstalledAddOn resource with the extension to update.
Pattern:
^XE[0-9a-fA-F]{32}$
Sid
type: SID<XF>
The SID of the InstalledAddOn Extension resource to update.
Pattern:
^XF[0-9a-fA-F]{32}$
Request body parameters
Enabled
type: booleanRequired
Whether the Extension should be invoked.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.preview.marketplace
_12 .installedAddOns('XB85b56ed9ce713e0ac62342b901233193')
_12 .extensions('XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .update({enabled: true})
_12 .then(installed_add_on_extension => console.log(installed_add_on_extension.enabled));
_10 "sid": "XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "installed_add_on_sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "friendly_name": "Incoming Voice Call",
_10 "product_name": "Programmable Voice",
_10 "unique_name": "voice-incoming",
_10 "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions/XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
The Incoming Phone Number Assigned Add-ons subresource details which Add-ons have been assigned to a given Twilio phone number. Assigning an Add-on to a specific Twilio phone number limits the invocation of that Add-on to Calls or Messages on that particular phone number.
Add-ons enabled for Recordings and TaskRouter do not support phone number assignments.
_10/2010-04-01/IncomingPhoneNumbers/{PhoneNumberSid}/AssignedAddOns
_10/2010-04-01/IncomingPhoneNumbers/{PhoneNumberSid}/AssignedAddOns/{AddOnConfigurationSid}
_10/2010-04-01/IncomingPhoneNumbers/{PhoneNumberSid}/AssignedAddOns/{AddOnConfigurationSid}/Extensions
Returns of a list of the Installed Add-ons assigned to the given Incoming Phone Number.
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.incomingPhoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(assignedAddOns => assignedAddOns.forEach(a => console.log(a.description)));
_29 "first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns.json?PageSize=50&Page=0",
_29 "next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns.json?PageSize=50&Page=50",
_29 "previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns.json?PageSize=50&Page=0",
_29 "assigned_add_ons": [
_29 "sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29 "resource_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29 "friendly_name": "VoiceBase High Accuracy Transcription",
_29 "description": "Automatic Transcription and Keyword Extract...",
_29 "unique_name": "voicebase_high_accuracy_transcription",
_29 "date_created": "Thu, 07 Apr 2016 23:52:28 +0000",
_29 "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000",
_29 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_29 "subresource_uris": {
_29 "extensions": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions.json"
_29 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns.json?PageSize=50&Page=0"
Returns a single instance of an Installed Add-on assigned to a given Incoming Phone Number.
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.incomingPhoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .assignedAddOns('XB85b56ed9ce713e0ac62342b901233193')
_11 .then(assigned_add_on => console.log(assigned_add_on.friendlyName));
_17 "sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "resource_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "friendly_name": "VoiceBase High Accuracy Transcription",
_17 "description": "Automatic Transcription and Keyword Extract...",
_17 "unique_name": "voicebase_high_accuracy_transcription",
_17 "date_created": "Thu, 07 Apr 2016 23:52:28 +0000",
_17 "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000",
_17 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_17 "subresource_uris": {
_17 "extensions": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions.json"
Allows you to assign an Installed Add-on to an Incoming Phone Number. The Add-on will only be invoked for the associated Incoming Phone Number.
URI parameters
ResourceSid
type: SID<PN>
The SID of the Phone Number to assign the Add-on.
Pattern:
^PN[0-9a-fA-F]{32}$
Request body parameters
InstalledAddOnSid
type: SID<XE>Required
The SID that identifies the Add-on installation.
Pattern:
^XE[0-9a-fA-F]{32}$
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.incomingPhoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .create({installedAddOnSid: 'XB85b56ed9ce713e0ac62342b901233193'})
_11 .then(assigned_add_on => console.log(assigned_add_on.sid));
_17 "sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "resource_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "friendly_name": "VoiceBase High Accuracy Transcription",
_17 "description": "Automatic Transcription and Keyword Extract...",
_17 "unique_name": "voicebase_high_accuracy_transcription",
_17 "date_created": "Thu, 07 Apr 2016 23:52:28 +0000",
_17 "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000",
_17 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_17 "subresource_uris": {
_17 "extensions": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions.json"
Deleting an Assigned Add-on instance resource will remove the binding between the Add-on and the Incoming Phone Number. Successful responses will return no content.
Returns a list of the Extensions for the Installed Add-on assigned to the given Incoming Phone Number.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.incomingPhoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .assignedAddOns('XB85b56ed9ce713e0ac62342b901233193')
_12 .then(extensions => extensions.forEach(e => console.log(e.sid)));
_23 "first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions.json?PageSize=50&Page=0",
_23 "next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions.json?PageSize=50&Page=50",
_23 "previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions.json?PageSize=50&Page=0",
_23 "sid": "XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "assigned_add_on_sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "resource_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "friendly_name": "Incoming Voice Call",
_23 "product_name": "Programmable Voice",
_23 "unique_name": "voice-incoming",
_23 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions/XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
_23 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions.json?PageSize=50&Page=0"
Returns a single Extension for the Installed Add-on assigned to the given Incoming Phone Number.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.incomingPhoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .assignedAddOns('XB85b56ed9ce713e0ac62342b901233193')
_12 .extensions('XF025b77384a62367bd120b7ce60250d7b')
_12 .then(assigned_add_on_extension => console.log(assigned_add_on_extension.friendlyName));
_11 "sid": "XF025b77384a62367bd120b7ce60250d7b",
_11 "assigned_add_on_sid": "XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "resource_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "friendly_name": "Incoming Voice Call",
_11 "product_name": "Programmable Voice",
_11 "unique_name": "voice-incoming",
_11 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IncomingPhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AssignedAddOns/XEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Extensions/XFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",