メニュー

Expand
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管理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.

メモ: Add-on管理APIは一般利用可能、またはベータ状態のAdd-onのみサポートしています。 まもなく登場、および開発者プレビューと記載のあるAdd-onはAPI経由でのアクセスは行えず、Console経由で管理を行うことが必要です。

Note: This API is currently in Developer Preview.

このAPIは開発者プレビューのため、下記ベースドメインからアクセスすることが必要です。

https://preview.twilio.com

APIはまた、次世代ヘルパーライブラリーからもアクセス可能です。


Available Add-ons API

利用可能なAdd-onのAPIは、アカウントから現在利用可能なAdd-onの詳細な説明を提供します。 このAPIはいかなるレコードの変更も許可されません。

URIs

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

プロパティ

Names in REST API format
sid
sid<XB> Not PII

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

friendly_name
文字列 Not PII

The string that you assigned to describe the resource.

description
文字列 Not PII

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

pricing_type
文字列 Not PII

How customers are charged for using this Add-on.

configuration_schema
オブジェクト Not PII

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

url
url Not PII

The absolute URL of the resource.

links
uri_map Not PII

The URLs of related resources.

Available Add-ons List Resource

HTTP GET

利用可能なAdd-onリソースの一覧を返します。

        
        
        
        

        Available Add-on Instance Resource

        HTTP GET

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

              
              
              
              


              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
              

              プロパティ

              Names in REST API format
              sid
              sid<XF> Not PII

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

              available_add_on_sid
              sid<XB> Not PII

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

              friendly_name
              文字列 Not PII

              The string that you assigned to describe the resource.

              product_name
              文字列 Not PII

              The name of the Product this Extension is used within.

              unique_name
              文字列 Not PII

              An application-defined string that uniquely identifies the resource.

              url
              url Not PII

              The absolute URL of the resource.

              Available Add-on Extensions List Resource

              HTTP GET

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

                    
                    
                    
                    


                    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}
                    

                    プロパティ

                    Names in REST API format
                    sid
                    sid<XE> Not PII

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

                    account_sid
                    sid<AC> Not PII

                    The SID of the Account that created the InstalledAddOn resource.

                    friendly_name
                    文字列 Not PII

                    The string that you assigned to describe the resource.

                    description
                    文字列 Not PII

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

                    configuration
                    オブジェクト Not PII

                    The JSON object that represents the current configuration of installed Add-on.

                    unique_name
                    文字列 Not PII

                    An application-defined string that uniquely identifies the resource.

                    date_created
                    date_time<iso8601> Not PII

                    The date and time in GMT when the resource was created specified in ISO 8601 format.

                    date_updated
                    date_time<iso8601> Not PII

                    The date and time in GMT when the resource was last updated specified in ISO 8601 format.

                    url
                    url Not PII

                    The absolute URL of the resource.

                    links
                    uri_map Not PII

                    The URLs of related resources.

                    Installed Add-ons List Resource

                    HTTP GET

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

                          
                          
                          
                          

                          Installed Add-on Instance Resource

                          HTTP GET

                          指定されたアカウントに関連づけられてインストールされたAdd-onの単一インスタンスを返します。

                                
                                
                                
                                

                                HTTP POST

                                利用可能なAdd-onをアカウントにインストールできるようになります。

                                パラメーター
                                Names in REST API format
                                available_add_on_sid
                                必須
                                post sid<XB> Not PII

                                The SID of the AvaliableAddOn to install.

                                accept_terms_of_service
                                必須
                                post boolean Not PII

                                Whether the Terms of Service were accepted.

                                configuration
                                オプション
                                post オブジェクト Not PII

                                The JSON object that represents the configuration of the new Add-on being installed.

                                unique_name
                                オプション
                                post 文字列 Not PII

                                An application-defined string that uniquely identifies the resource. This value must be unique within the Account.

                                      
                                      
                                      
                                      

                                      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.

                                      Names in REST API format
                                      sid
                                      Path
                                      post sid<XE> Not PII

                                      The SID of the InstalledAddOn resource to update.

                                      configuration
                                      オプション
                                      post オブジェクト Not PII

                                      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

                                      unique_name
                                      オプション
                                      post 文字列 Not PII

                                      An application-defined string that uniquely identifies the resource. This value must be unique within the Account.

                                            
                                            
                                            
                                            


                                            HTTP DELETE

                                            アカウントからAdd-onをアンインストールします。 Add-onが着信用電話番号に現在割り当てられている場合、APIは400を返し、ユーザーに割り当てを解除するよう通知します。 正常なレスポンスでは、No Contentが返ります。


                                            インストールされたAdd-on Extention 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.

                                            インストールされたAdd-on Extention APIはインストール済みのAdd-onが呼び出された時にそれを表示および構成することができるようになります。

                                            Add-onのロールアウトをユーザー自身で制御できるよう、既定では全Extensionはオフになっています。 これは、インストール済みのAdd-onでこれらが使用可能になる前に追加のAPIリクエストを発行し、Extensionを有効にする必要があるということです。 これにより、Extensionの有効化の前に着信用電話番号にインストール済みAdd-onをまず紐づけておく機会が与えられます。

                                            The following table lists the currently supported Extensions. Each Add-on typically supports a subset of these Extensions.

                                            Product Name わかりやすい名前 ユニーク名
                                            Lookup ルックアップ lookup-api
                                            Programmable SMS 受信SMSメッセージ 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}
                                            

                                            プロパティ

                                            Names in REST API format
                                            sid
                                            sid<XF> Not PII

                                            The unique string that we created to identify the InstalledAddOn Extension resource.

                                            installed_add_on_sid
                                            sid<XE> Not PII

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

                                            friendly_name
                                            文字列 Not PII

                                            The string that you assigned to describe the resource.

                                            product_name
                                            文字列 Not PII

                                            The name of the Product this Extension is used within.

                                            unique_name
                                            文字列 Not PII

                                            An application-defined string that uniquely identifies the resource.

                                            enabled
                                            boolean Not PII

                                            Whether the Extension will be invoked.

                                            url
                                            url Not PII

                                            The absolute URL of the resource.

                                            インストール済みAdd-on Extensionのリストリソース

                                            HTTP GET

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

                                                  
                                                  
                                                  
                                                  

                                                  Installed Add-on Extension Instance Resource

                                                  HTTP GET

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

                                                        
                                                        
                                                        
                                                        


                                                        HTTP POST

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

                                                        必須パラメーター
                                                        Names in REST API format
                                                        installed_add_on_sid
                                                        Path
                                                        post sid<XE> Not PII

                                                        The SID of the InstalledAddOn resource with the extension to update.

                                                        sid
                                                        Path
                                                        post sid<XF> Not PII

                                                        The SID of the InstalledAddOn Extension resource to update.

                                                        enabled
                                                        必須
                                                        post boolean Not PII

                                                        Whether the Extension should be invoked.

                                                              
                                                              
                                                              
                                                              


                                                              Add-on 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
                                                              

                                                              割り当て済みAdd-onプロパティー

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

                                                              Add-onリストリソースに関連づけられた電話番号

                                                              HTTP GET

                                                              指定された着信用電話番号に関連づけられたインストール済みAdd-onの一覧を返します。

                                                                    
                                                                    
                                                                    
                                                                    

                                                                    Add-onインスタンスリソースに関連づけられた電話番号

                                                                    HTTP GET

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

                                                                          
                                                                          
                                                                          
                                                                          

                                                                          HTTP POST

                                                                          着信用電話番号にインストール済みAdd-onを関連づけられるようになります。 これにより、関連づけられた着信用電話番号に対してのみAdd-onを呼び出せるようになります。

                                                                          必須パラメーター
                                                                          Names in REST API format
                                                                          account_sid
                                                                          Path
                                                                          post sid<AC> Not PII

                                                                          The SID of the Account that will create the resource.

                                                                          resource_sid
                                                                          Path
                                                                          post sid<PN> Not PII

                                                                          The SID of the Phone Number to assign the Add-on.

                                                                          installed_add_on_sid
                                                                          必須
                                                                          post sid<XE> Not PII

                                                                          The SID that identifies the Add-on installation.

                                                                                
                                                                                
                                                                                
                                                                                

                                                                                HTTP DELETE

                                                                                関連づけられたAdd-onインスタンスリソースを削除すると、Add-onと着信用電話番号の関連づけが切り離されます。 正常なレスポンスでは、No Contentが返ります。


                                                                                電話番号の割り当てられたAdd-on Extension

                                                                                プロパティ

                                                                                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

                                                                                指定された着信用電話番号に割り当てられたインストール済みAdd-onに対するExtensionの一覧を返します。

                                                                                      
                                                                                      
                                                                                      
                                                                                      

                                                                                      Assigned Add-on Extension Instance Resource

                                                                                      HTTP GET

                                                                                      指定された着信用電話番号に割り当てられたインストール済みAdd-onに対する単一のExtensionを返します。

                                                                                            
                                                                                            
                                                                                            
                                                                                            
                                                                                            Rate this page:

                                                                                            ヘルプが必要ですか?

                                                                                            誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。