Webhook
HTTPエンドポイントを呼び出すカスタムツールを受付担当に追加します。
Webhook Tool インテグレーションを使うと、受付担当やビジネスアシスタントが会話中に呼び出せるツールとしてHTTPエンドポイントを公開できます。会話の内容に基づいて、AIがエンドポイントを呼び出すタイミングを判断します。
Webhookツールの仕組み
Webhookツールを作成するときは、以下を定義します。
- 呼び出すHTTPエンドポイント。
- AIが使用するタイミングを判断できるよう、その機能の説明。
- AIが会話から収集するパラメーター。
通話中、会話がツールの用途に一致すると、受付担当がパラメーターを収集し、エンドポイントを呼び出して、そのレスポンスを使って会話を続けます。
Webhookツールの作成
Integrations に移動し、Add integration を選択して、Webhook Tool を選びます。以下のフィールドを設定し、Enable を選択します。Webhookツールは複数追加できます。
パラメーター
各パラメーターには以下の項目があります。
- Key:フィールド名。英字、数字、アンダースコア、ハイフン、
@、単一のピリオドを使用できます。角括弧は使用できないため、filter[name]のようなキーを必要とするAPIを直接呼び出すことはできません。 - Type:
string、number、integer、またはboolean。ボディパラメーターではobjectまたはarrayも使用できます。 - Value:AIが入力する From the conversation、またはリクエストごとに送信する Fixed value。
- Description:AIが会話から抽出する値の説明。
- Required:呼び出す前にAIがその値を収集する必要があるかどうか。
件数、ID、0/1フラグなどの整数にはintegerを使用してください。固定のnumberは
小数点付きで送信されるため、1は1.0として届きます。一部のAPIでは拒否されることがあります。
ElevenAgentsで変数から値を取得するよう設定されたパラメーターは読み取り専用で表示され、エージェントプラットフォームで設定されている旨の注記が付きます。値はそこでの設定どおりに送信されます。
オブジェクトとリスト
多くのAPIでは、電話番号のリストを含む連絡先など、関連するフィールドをまとめる必要があります。ボディパラメーターでは、以下の形式で送信できます。
objectはフィールドをグループ化します。各フィールドを追加するには Add field を選択します。各フィールドにはそれぞれキー、型、値があります。arrayはリストです。Each item で項目の型を選択します。オブジェクトのリストを使うと、電話番号ごとに1件ずつなど、同じ構造の複数の項目をAIが送信できます。
フィールドは最大5階層までネストできます。オブジェクトやリストは常に会話から取得されますが、オブジェクト内のフィールドには、変更されないラベルやIDなどの Fixed value を設定できます。
たとえば、次のボディパラメーターを設定します。
name:文字列、会話から取得phones:配列。各項目は次の2つのフィールドを持つオブジェクトnumber:文字列、会話から取得label:文字列、mobileに固定
source:1つのフィールドを持つオブジェクト。channel:文字列、phoneに固定
この場合、次のようなリクエストボディが送信されます。
ユースケース
例
ある配管工事会社が次のWebhookツールを作成するとします。
- Name:
check_service_area - Description: 「発信者の郵便番号がサービス提供地域内かどうかと、次に予約できる時間帯を確認する」
- URL:
https://api.mybusiness.com/check-area - Method: POST
- Request Headers:
Authorizationに会社のAPIキーを Secret として設定 - Body Parameters:
zip_code(文字列、必須)、service_type(文字列、必須)
発信者が自分の地域でサービスを利用できるか尋ねると、受付担当が郵便番号を確認してWebhookを呼び出し、結果を伝えます。
Webhookツールはすべてのプランで利用できます。