跳到导航

Webhook

为接待员提供可调用 HTTP 端点的自定义工具。

Webhook Tool 集成可将 HTTP 端点公开为工具,接待员或业务助手可在对话中调用这些工具。AI 会根据对话内容决定何时调用端点。

Webhook 工具的工作方式

创建 webhook 工具时,需要定义:

  1. 要调用的 HTTP 端点。
  2. 工具用途说明,让 AI 知道何时使用。
  3. AI 应从对话中收集的参数。

通话期间,当对话符合工具用途时,接待员会收集参数、调用端点,并根据响应继续对话。

创建 webhook 工具

前往 集成,选择 添加集成,然后选择 Webhook Tool。配置以下字段并选择 启用。你可以添加多个 webhook 工具。

字段说明
名称AI 可见的工具名称,例如 check_order_status
说明使用此工具的时机和原因
方法GET、POST、PUT、PATCH 或 DELETE
URLHTTP 端点
响应超时(秒)等待服务器响应的时长:5–120 秒,默认为 20 秒
分配给智能体接待员、助手智能体,或两者
禁用打断工具运行时阻止来电者打断
请求标头每次请求都会发送的可选标头。类型为 值 或 密钥。密钥会加密存储,且不会再次显示。从 ElevenAgents 引入的标头可显示为 环境变量 或 变量,并注明其在智能体平台中设置。
路径参数当 URL 包含花括号中的占位符时显示,例如 /orders/{order_id}。编辑 URL 可添加或移除参数。
请求体参数作为 JSON 请求体发送的参数,适用于 POST、PUT 和 PATCH。可以是对象和列表。
查询参数作为 URL 查询字符串发送的参数。每项均为单个值。

参数

每个参数包含:

  • 键:字段名称。可使用字母、数字、下划线、连字符、@ 和单个点号。不支持方括号,因此无法直接调用需要 filter[name] 等键的 API。
  • 类型:string、number、integer 或 boolean。请求体参数还可使用 object 或 array。
  • 值:由 AI 填写的 来自对话,或每次请求都发送的 固定值。
  • 说明:AI 应从对话中提取的值。
  • 必填:AI 是否必须在调用前收集该参数。

对计数、ID 和 0/1 标记等整数使用 integer。固定的 number 会带小数点发送, 因此 1 会以 1.0 形式送达,部分 API 会拒绝该值。

在 ElevenAgents 中配置为从变量获取值的参数会显示为只读,并注明其在智能体平台中设置。系统会按该处配置发送。

对象和列表

许多 API 要求将相关字段分组,例如包含电话号码列表的联系人。请求体参数可发送以下类型:

  • object 用于分组字段。选择 添加字段 可添加每个字段;每个字段都有自己的键、类型和值。
  • array 是列表。在 每个项目 下选择列表项类型。对象列表可让 AI 发送多个结构相同的条目,例如每个电话号码对应一项。

字段最多可嵌套 5 层。对象或列表始终来自对话,但对象内的字段可以使用 固定值,例如永不变更的标签或 ID。

例如,以下请求体参数:

  • name:字符串,来自对话
  • phones:数组,每项均为包含两个字段的对象:
    • number:字符串,来自对话
    • label:字符串,固定为 mobile
  • source:包含一个字段的对象,channel:字符串,固定为 phone

会发送如下请求体:

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

使用场景

场景说明方法
CRM 查询在系统中查询客户信息GET
库存检查实时检查产品库存GET
潜在客户收集将来电者信息发送到营销系统POST
创建工单通话期间创建支持工单POST
报价根据来电者需求计算定制报价POST

示例

一家管道服务企业创建了一个 webhook 工具:

  • 名称: check_service_area
  • 说明: “检查我们是否为来电者所在邮政编码地区提供服务,以及下一个可预约时段。”
  • URL: https://api.mybusiness.com/check-area
  • 方法: POST
  • 请求标头: 将 Authorization 设置为企业的 API 密钥,类型为 密钥
  • 请求体参数: zip_code(字符串,必填)、service_type(字符串,必填)

当来电者询问其所在地区的服务时,接待员会收集其邮政编码、调用 webhook,并告知结果。

所有套餐均提供 webhook 工具。