Webhook
为接待员提供可调用 HTTP 端点的自定义工具。
Webhook Tool 集成可将 HTTP 端点公开为工具,接待员或业务助手可在对话中调用这些工具。AI 会根据对话内容决定何时调用端点。
Webhook 工具的工作方式
创建 webhook 工具时,需要定义:
- 要调用的 HTTP 端点。
- 工具用途说明,让 AI 知道何时使用。
- AI 应从对话中收集的参数。
通话期间,当对话符合工具用途时,接待员会收集参数、调用端点,并根据响应继续对话。
创建 webhook 工具
前往 集成,选择 添加集成,然后选择 Webhook Tool。配置以下字段并选择 启用。你可以添加多个 webhook 工具。
参数
每个参数包含:
- 键:字段名称。可使用字母、数字、下划线、连字符、
@和单个点号。不支持方括号,因此无法直接调用需要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
会发送如下请求体:
使用场景
示例
一家管道服务企业创建了一个 webhook 工具:
- 名称:
check_service_area - 说明: “检查我们是否为来电者所在邮政编码地区提供服务,以及下一个可预约时段。”
- URL:
https://api.mybusiness.com/check-area - 方法: POST
- 请求标头: 将
Authorization设置为企业的 API 密钥,类型为 密钥 - 请求体参数:
zip_code(字符串,必填)、service_type(字符串,必填)
当来电者询问其所在地区的服务时,接待员会收集其邮政编码、调用 webhook,并告知结果。
所有套餐均提供 webhook 工具。