Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

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データの使用

アドオンの使い方は簡単です。アドオンをインストールして、特定の Twilio 製品で有効にした後は、その製品固有の API を使用して、アドオンから JSON ディクショナリーとして返された結果を利用するだけです。

一部の製品(ルックアップなど)では、Twilio API を呼び出す際に、使用するアドオンと実行時データも指定する必要があります。アドオンの使用方法とその結果の利用方法をまとめた表を次に示します。

Twilio 製品 有効なアドオンの使用方法 アドオンの結果の利用方法
Lookup AddOns パラメーターを使用して、呼び出すアドオンのユニークな名前を指定します。

アドオンが実行時データを必要とする場合は、AddOns.<unique_name>.<parameter_name> をサポートします。
アドオンの結果は、レスポンスの add_ons パラメーターに格納されます。
Programmable SMS コンソールでこの製品に対して有効にしたすべてのアドオンが、SMS の着信のたびに自動的に呼び出されます。

注意:発信 SMS では、現在はアドオンはサポートされていません。
アドオンの結果は、着信 SMS webhook の AddOns パラメーターに格納されます。

GET コールバックの URL の長さの制約により、POST コールバックでのみサポートされることに注意してください。
プログラマブル Voice - 通話 コンソールでこの製品に対して有効にしたすべてのアドオンが、音声通話の着信のたびに自動的に呼び出されます。

注意:発信通話では、現在はアドオンはサポートされていません。
アドオンの結果は、着信音声通話 TwiML コールバックの AddOns パラメーターに格納されます。

GET コールバックの URL の長さの制約により、POST コールバックでのみサポートされることに注意してください。
プログラマブル Voice - 録音 All Add-ons enabled for this product inside the Console are automatically invoked for each Recording. Add-onの結果は、Add-on構成パラメーター内に指定されたURLへのコールバック内のAddOnsで通知されます。

同期的Add-onの結果

Sync Add-onのフロー

同期的な特性を持つAdd-on(ほとんどのLookup、Messaging、着信Voice Add-on)の結果の利用可否は関連するTwilio APIに下記の形式のJSONディクショナリーによって返されます:

パラメーター 概要
status successful または fail
code Error code if status = fail, else null. Add-onのエラーコードは61xxxの範囲内にあります。 説明についてはエラーのリファレンスページを参照してください。
message 何が間違っていたかを示す説明的なメッセージ。status が successful の場合は null です。
results キーがアドオンのユニークな名前、値が呼び出し結果である JSON ディクショナリー。

結果フィールドはAdd-onの一意な名前(Unique Name)をキー、Add-onの結果を値としたJSONディクショナリーです。

パラメーター 概要
request_sid アドオンに対するこの特定のリクエストのユニークな識別子。
status successful または fail
code Error code if status = fail, else null. Add-onのエラーコードは61xxxの範囲内にあります。 説明についてはエラーのリファレンスページを参照してください。
message 何が間違っていたかを示す説明的なメッセージ。status が successful の場合は null です。
result アドオン固有の結果を示す JSON オブジェクト。このフィールドの内容の詳細については、コンソールのアドオン詳細ページにある、アドオン固有のドキュメントをご覧ください。

パフォーマンスの検討事項

アドオンのタイプ SLA/遅延 サイズの制限
電話番号およびメッセージ分析アドオン Because this request is returned synchronously, in the flow of an Incoming Call, Lookup or SMS delivery, performance is key. Any request taking longer than 2000 ms will be failed by Twilio, an error payload will be sent, and the developer will not be billed. 同期的なアドオンなので、これに対するレスポンスは最大 64KB に制限されます。レスポンスのサイズがこの最大値を超えると、Twilio は失敗と判断してエラーペイロードを送信し、開発者は課金されません。

同期的Add-on JSONレスポンスの例

        
        
        
        
        Applies to Add-ons for Lookup, Incoming Voice Calls, Incoming SMS and Taskrouter

        Example of Synchronous Add-on response

        Applies to Add-ons for Lookup, Incoming Voice Calls, Incoming SMS and Taskrouter

        非同期的Add-onの結果

        Async Add-onのフロー

        非同期のAdd-on(たとえばすべてのRecording Add-on)について、Add-on結果の利用可否はAdd-on Results Available Webhook(Add-on結果の利用可能Webhook)経由で、Add-on構成パラメーター内に指定されたCallback URLへのPOSTリクエストとして通知されます。

        Add-on Results Available Callback

        Add-on Result Available Webhookの本文には下記の形式を持つJSONディクショナリーを伴うAddOnsパラメーターが含まれます。

        パラメーター 概要
        status successful または fail
        code Error code if status = fail, else null. Add-onのエラーコードは61xxxの範囲内にあります。 説明についてはエラーのリファレンスページを参照してください。
        message 何が間違っていたかを示す説明的なメッセージ。status が successful の場合は null です。
        results Add-onの一意な名前(Unique Name)がキー、呼び出し結果が値となるJSONディクショナリーです

        results フィールドはAdd-onの一意な名前(Unique Name)をキー、Add-onの結果を値とするJSONディクショナリーです:

        パラメーター 概要
        request_sid アドオンに対するこの特定のリクエストのユニークな識別子。
        status successful または fail
        code status が fail の場合はエラーコード、それ以外の場合は null です。エラーコードの説明については、[link] をご覧ください。
        message 何が間違っていたかを示す説明的なメッセージ。status が successful の場合は null です。
        payload 実際の結果に対するURIを含むディクショナリーの一覧です。
        links 結果の生成に使用されたリファレンスメディア(録音など)へのURIを含むディクショナリーです。

        payload ディクショナリー形式:

        パラメーター 概要
        content_type Add-onによって返されるコンテンツのMime型です(例: application/jsonまたはaudio/wav)。 返されるコンテンツの詳細についてはAdd-onドキュメントを参照してください。
        url URL that contains the actual content. This is the Add-on Result Payload Data as outlined in the Add-on Results API here. Note: You will need to perform an authenticated GET using your Twilio credentials to retrieve this data.

        links ディクショナリー形式:

        パラメーター 概要
        recording 結果を生成した録音に対するRecordingインスタンスリソースのURLです。
        add_on_result URL of the Add-on Result instance metadata. See Add-on Results API here
        payloads URL of the Add-on Result Payloads list metadata. See Add-on Results API here

        パフォーマンスの検討事項

        アドオンのタイプ SLA/遅延 サイズの制限
        録音分析アドオン このリクエストへの応答は非同期的に行われるので、厳しい要件はありません。このタイプのアドオンは、音声ファイルの長さの平均 3 倍の時間で応答し、その 99% は 5 倍未満であるようにすることを推奨します。リクエストへの応答時間が [音声ファイルの長さの 10 倍の時間 ?] を超えると、Twilio は失敗と判断してエラーペイロードを送信し、開発者は課金されません。 非同期的なアドオンなので、これに対するレスポンスは最大 100MB に制限されます。レスポンスのサイズがこの最大値を超えると、Twilio は失敗と判断してエラーペイロードを送信し、開発者は課金されません。

        コールバックで利用可能な非同期Add-onの例

              
              
              
              
              Applies to callbacks received for Recording Analysis Add-ons. Note that this JSON is contained within the "AddOns" POST parameter.

              Example of Asynchronous Add-on Results available callback

              Applies to callbacks received for Recording Analysis Add-ons. Note that this JSON is contained within the "AddOns" POST parameter.

              Add-on Results API

              Results of Asynchronous Add-ons (such as Recording Add-ons) are also available for 30 days via the Add-on Results API.

              Rate this page:

              ヘルプが必要ですか?

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