Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Add-on Management API

This guide describes the APIs to retrieve available and installed Add-ons, as well as install specific Add-ons and manage their extension(s). This API complements the Add-on capabilities exposed via the Console to provide programmatic access.

Note: The Add-on Management API only supports Add-ons that are in 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 via the Console.

Note: This API is currently in Developer Preview.

While this API is in Developer Preview, it should be accessed via the following base domain:

https://preview.twilio.com

The API may also be accessed via Next-gen helper libraries.


Available Add-ons API

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.

URIs

/marketplace/AvailableAddOns
/marketplace/AvailableAddOns/{AddOnSid} 

Properties

configuration_schema
object Not PII

The JSON Schema describing configuration that must be provided when installing a given Add-on.

description
string Not PII

A short description of the functionality provided by the Add-on.

friendly_name
string Not PII

A human-readable description of this Add-on.

pricing_type
string Not PII

The mechanism by which customers are charged for using this Add-on.

sid
sid<XB> Not PII

A 34 character string that uniquely identifies this Add-on.

Available Add-ons List Resource

HTTP GET

Returns a list of Available Add-on resources.

Loading Code Sample...
      
      
          
          
          
          
        

      Available Add-on Instance Resource

      HTTP GET

      Returns a single instance of an Available Add-on resource.

      Loading Code Sample...
          
          
              
              
              
              
            


          Available Add-on Extensions API

          The Available Add-on Extension subresource details where a given Available Add-on can be invoked.

          URIs

          /marketplace/AvailableAddOns/{AddOnSid}/Extensions
          

          Properties

          friendly_name
          string Not PII

          A human-readable description of this Extension.

          product_name
          string Not PII

          A human-readable description of the Product this Extension is used within.

          sid
          sid<XF> Not PII

          A 34 character string that uniquely identifies this Extension.

          unique_name
          string Not PII

          The human-readable string that uniquely identifies this Extension.

          Available Add-on Extensions List Resource

          HTTP GET

          Returns a list of Extension resources that detail the invocation points for the Available Add-on.

          Loading Code Sample...
              
              
                  
                  
                  
                  
                


              Installed Add-ons API

              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, with different Add-on Configurations. Upon installation, the Add-on is identified by an AddOnConfigurationSid.

              URIs

              /marketplace/InstalledAddOns
              
              /marketplace/InstalledAddOns/{AddOnConfigurationSid}
              

              Properties

              account_sid
              sid<AC> Not PII

              The unique id of the Account that has installed this Add-on.

              configuration
              object Not PII

              The JSON object representing the current configuration of this Add-on installation.

              date_created
              date_time<iso8601> Not PII

              The date that this Add-on installation was created, given in ISO 8601 format.

              date_updated
              date_time<iso8601> Not PII

              The date that this Add-on installation was last updated, given in ISO 8601 format.

              description
              string Not PII

              A short description of the functionality provided by the Add-on.

              friendly_name
              string Not PII

              A human-readable description of this Add-on installation.

              links
              uri_map Not PII

              A dictionary of URLs for related resource.

              sid
              sid<XE> Not PII

              34 character string that uniquely identifies the Add-on. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'.

              unique_name
              string Not PII

              The human-readable string that uniquely identifies an Add-on installation for an Account.

              Installed Add-ons List Resource

              HTTP GET

              Returns a list of Installed Add-ons associated with the given Account.

              Loading Code Sample...
                  
                  
                      
                      
                      
                      
                    

                  Installed Add-on Instance Resource

                  HTTP GET

                  Returns a single instance of an Installed Add-on associated with the given Account.

                  Loading Code Sample...
                      
                      
                          
                          
                          
                          
                        

                      HTTP POST

                      Allows you to install an Available Add-on to their Account.

                      Parameters
                      AcceptTermsOfService
                      Required
                      post boolean Not PII

                      A boolean that reflects your decision whether to accept the Terms of Service

                      AvailableAddOnSid
                      Required
                      post sid<XB> Not PII

                      A 34 character string that uniquely identifies the Add-on to be installed.

                      Configuration
                      Optional
                      post object Not PII

                      The JSON object representing the configuration of the new Add-on installation.

                      UniqueName
                      Optional
                      post string Not PII

                      The human-readable string that uniquely identifies this Add-on installation for an Account.

                      Loading Code Sample...
                          
                          
                              
                              
                              
                              
                            

                          HTTP POST

                          Allows you to update the configuration for an Installed Add-on by POSTing a JSON object that validates against the schema exposed by the Available Add-on.

                          Configuration
                          Optional
                          post object Not PII

                          Valid JSON object that conform to the configuration schema exposed by the associated Available Add-on resource. This is only required by Add-ons that need to be configured

                          UniqueName
                          Optional
                          post string Not PII

                          The human-readable string that uniquely identifies this Add-on installation for an Account.

                          Loading Code Sample...
                              
                              
                                  
                                  
                                  
                                  
                                


                              HTTP DELETE

                              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 informing the user to remove the assignments. Successful responses will return no content.


                              Installed Add-on Extensions API

                              An Extension identifies a Twilio product or an integration point in a Twilio product where the Add-on gets invoked. Examples of Extensions include : Record Verb, Dial Verb, 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

                              URIs

                              /marketplace/InstalledAddOns/{AddOnConfigurationSid}/Extensions
                              
                              /marketplace/InstalledAddOns/{AddOnConfigurationSid}/Extensions/{AddOnExtensionSid}
                              

                              Properties

                              enabled
                              boolean Not PII

                              A Boolean indicating if the Extension will be invoked.

                              friendly_name
                              string Not PII

                              A human-readable description of this Extension.

                              product_name
                              string Not PII

                              A human-readable description of the Product this Extension is used within.

                              sid
                              sid<XF> Not PII

                              A 34 character string that uniquely identifies this Extension.

                              unique_name
                              string Not PII

                              The human-readable string that uniquely identifies this Extension.

                              Installed Add-on Extensions List Resource

                              HTTP GET

                              Returns a list of Extensions where the Add-on can be invoked.

                              Loading Code Sample...
                                  
                                  
                                      
                                      
                                      
                                      
                                    

                                  Installed Add-on Extension Instance Resource

                                  HTTP GET

                                  Returns a single instance of an Add-on Extension resource.

                                  Loading Code Sample...
                                      
                                      
                                          
                                          
                                          
                                          
                                        


                                      HTTP POST

                                      Allows you to activate or deactivate an Extension point associated with the Installed Add-on.

                                      Required Parameters
                                      Enabled
                                      Required
                                      post boolean Not PII

                                      A Boolean indicating if the Extension will be invoked.

                                      Loading Code Sample...
                                          
                                          
                                              
                                              
                                              
                                              
                                            


                                          Incoming Phone Number Assigned Add-ons API

                                          The Incoming Phone Number Assigned Add-ons Subresource details which Add-ons have been assigned for a given Twilio phone number. Assigning an Add-on to a specific Twilio phone number limits the invocation of that Add-on only for Calls or Messages on that particular Phone number.

                                          Note that Add-ons enabled for Recordings and TaskRouter do not support phone number assignments.

                                          URIs

                                          /2010-04-01/IncomingPhoneNumbers/{PhoneNumberSid}/AssignedAddOns
                                          
                                          /2010-04-01/IncomingPhoneNumbers/{PhoneNumberSid}/AssignedAddOns/{AddOnConfigurationSid}
                                          
                                          /2010-04-01/IncomingPhoneNumbers/{PhoneNumberSid}/AssignedAddOns/{AddOnConfigurationSid}/Extensions
                                          

                                          Assigned Add-on Properties

                                          As a subresource this API will expose the same properties in the Installed Add Ons API.

                                          Phone Number Assigned Add-on List Resource

                                          HTTP GET

                                          Returns of a list of the Installed Add-ons assigned to the given Incoming Phone Number.

                                          Loading Code Sample...
                                              
                                              
                                                  
                                                  
                                                  
                                                  
                                                

                                              Phone Number Assigned Add-on Instance Resource

                                              HTTP GET

                                              Returns a single instance of an Installed Add-on assigned to the given Incoming Phone Number.

                                              Loading Code Sample...
                                                  
                                                  
                                                      
                                                      
                                                      
                                                      
                                                    

                                                  HTTP POST

                                                  Allows you to assign an Installed Add-on with an Incoming Phone Number. This will limit the Add-on to only be invoked for associated Incoming Phone Number.

                                                  Required Parameters
                                                  InstalledAddOnSid
                                                  Required
                                                  post sid<XE> Not PII

                                                  A 34 character string that uniquely identifies the Add-on installation.

                                                  Loading Code Sample...
                                                      
                                                      
                                                          
                                                          
                                                          
                                                          
                                                        

                                                      HTTP DELETE

                                                      Deleting at the Assigned Add-on instance resource will remove the assignment between the Add-on and the Incoming Phone Number. Successful responses will return no content.


                                                      Phone Number Assigned Add-on Extensions

                                                      Properties

                                                      As a subresource this API will expose the same properties in the installed Add-ons Extension API.

                                                      Assigned Add-on Extension List Resource

                                                      HTTP GET

                                                      Returns a list of the Extensions for the Installed Add-on assigned to the given Incoming Phone Number.

                                                      Loading Code Sample...
                                                          
                                                          
                                                              
                                                              
                                                              
                                                              
                                                            

                                                          Assigned Add-on Extension Instance Resource

                                                          HTTP GET

                                                          Returns a single Extension for the Installed Add-on assigned to the given Incoming Phone Number.

                                                          Loading Code Sample...
                                                              
                                                              
                                                                  
                                                                  
                                                                  
                                                                  
                                                                

                                                              Need some help?

                                                              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

                                                              Loading Code Sample...