ナビゲーションにスキップ

Webhook

HTTPエンドポイントを呼び出すカスタムツールを受付担当に追加します。

Webhook Tool インテグレーションを使うと、受付担当やビジネスアシスタントが会話中に呼び出せるツールとしてHTTPエンドポイントを公開できます。会話の内容に基づいて、AIがエンドポイントを呼び出すタイミングを判断します。

Webhookツールの仕組み

Webhookツールを作成するときは、以下を定義します。

  1. 呼び出すHTTPエンドポイント。
  2. AIが使用するタイミングを判断できるよう、その機能の説明。
  3. AIが会話から収集するパラメーター。

通話中、会話がツールの用途に一致すると、受付担当がパラメーターを収集し、エンドポイントを呼び出して、そのレスポンスを使って会話を続けます。

Webhookツールの作成

Integrations に移動し、Add integration を選択して、Webhook Tool を選びます。以下のフィールドを設定し、Enable を選択します。Webhookツールは複数追加できます。

フィールド説明
NameAIに表示されるツール名(例:check_order_status)
Descriptionこのツールをいつ、なぜ使用するか
MethodGET、POST、PUT、PATCH、またはDELETE
URLHTTPエンドポイント
Response timeout (seconds)サーバーからの応答を待つ時間:5~120秒、デフォルトは20秒
Assign to agentsReceptionist、Assistant agent、またはその両方
Disable interruptionsツールの実行中に発信者が割り込めないようにする
Request Headersリクエストごとに送信する任意のヘッダー。Type は Value または Secret です。Secret は暗号化して保存され、以後は表示されません。ElevenAgentsから取り込んだヘッダーには Environment variable または Variable と表示され、エージェントプラットフォームで設定されている旨の注記が付きます。
Path ParametersURLに/orders/{order_id}のような波括弧付きのプレースホルダーが含まれる場合に表示されます。追加または削除するにはURLを編集します。
Body ParametersJSONリクエストボディとして送信するパラメーター。POST、PUT、PATCHの場合に表示されます。オブジェクトとリストも使用できます。
Query ParametersURLクエリ文字列として送信するパラメーター。それぞれ単一の値です。

パラメーター

各パラメーターには以下の項目があります。

  • 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に固定

この場合、次のようなリクエストボディが送信されます。

{
"name": "Jane Doe",
"phones": [{ "number": "+15551234567", "label": "mobile" }],
"source": { "channel": "phone" }
}

ユースケース

シナリオ説明メソッド
CRM検索システム内の顧客情報を検索GET
在庫確認プロダクトの在庫状況をリアルタイムで確認GET
リード獲得発信者の情報をマーケティングシステムに送信POST
チケット作成通話中にサポートチケットを作成POST
見積もり発信者の要件に基づいて個別の見積もりを計算POST

例

ある配管工事会社が次の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ツールはすべてのプランで利用できます。