总结
在 Wati 的 聊天机器人构建器 中,Webhooks 允许您通过 GET 或 POST API 请求在聊天机器人和外部应用之间发送和接收实时数据。此功能使聊天机器人交互更具动态性,例如获取用户详细信息、验证数据或与第三方服务集成。注意: Webhook 功能仅在 Pro & Business 计划中可用。如果您使用标准计划,可以创建并保存带有 Webhook 的聊天机器人,但需要升级才能在 Keyword Action 或 Default Action 工作流中使用它们。
说明
高级聊天机器人构建器仅在 Pro & Business 计划中可用。
如何在聊天机器人构建器中使用 Webhooks
1. 向聊天机器人添加 Webhook
打开 Wati 聊天机器人构建器。
将 Webhook 图标拖放到聊天机器人工作流中。
将其连接到相关的聊天机器人步骤。
2. 配置 Webhook 节点
URL & 方法
选择一个 请求方法:
GET
或POST
。输入外部 API 的 URL 端点。
通过使用 变量 按钮插入变量来使 URL 动态化。示例:
https://webhook-wa-testing.clare.ai/123456789?name=####{{name}}
自定义头部
头部提供有关请求的其他详细信息(如内容类型或授权)。
头部是可选的,默认情况下关闭。
头部采用 键值 格式。示例:
键 =
Content-Type
值 =
application/json
自定义正文
请求正文包含发送到外部 API 的数据。
正文是可选的,默认情况下关闭。
它必须始终以 JSON 格式 提供。
设置测试变量
在 setup 期间手动定义测试变量以模拟 API 响应。
3. 测试 Webhook 请求
点击 测试请求 以验证 API 调用是否正常工作。
4. 将 API 响应保存为变量
您可以将 API 的响应存储到 变量 或 自定义属性 中。
如果 API 返回带有 键值 对的 JSON 响应,您可以提取和存储特定值。示例: 从 API 响应中存储
"result": "success"
:
json { "result": "success"}
在对象内存储值
使用格式:
objectKey.keyName
。示例:若要从下面的响应中存储
QuoteId
,请使用Result.QuoteId
。
json { "Result": { "QuoteId": "xxxxx", "QuoteNumber": "xxxxxx", "PolicyNumber": null }, "MessageValidation": null, "QuoteReferrals": null}
在对象数组中存储值
使用格式:
$.[0].objectKey.keyName[0].value
。示例:要存储
current_status
,请使用$.[0].tracking_data.shipment_track[0].current_status
。
json [ { "tracking_data": { "track_status": 1, "shipment_track": [ { "id": 1278937320, "current_status": "Delivered" } ] } }]
5. 使用响应路由
响应路由允许您根据响应状态代码 分割聊天机器人操作。
您可以根据 API 响应定义不同的聊天机器人流程。
通过集成 Webhooks,可以用外部数据增强聊天机器人功能,自动化工作流并动态改善用户交互体验。
常见问题解答(FAQ)
通用问题
1. Wati 聊天机器人构建器中的 Webhook 是什么?
→ Webhook 是一种机制,它允许您的聊天机器人通过 GET 或 POST API 请求从外部应用程序接受和发送实时数据。它使动态交互成为可能,例如获取用户详细信息,验证数据,或与第三方服务集成。
2. 谁可以在聊天机器人构建器中使用 Webhook?
→ Webhook 功能仅在 Pro & Business 计划中可用。如果您使用的是标准计划,您可以创建并保存带有 Webhook 的聊天机器人,但必须在使用它们进行 Keyword Action 或 Default Action 工作流之前升级。
设置和配置
3. 如何将 Webhook 添加到我的聊天机器人中?
→ 要添加 Webhook:
打开 Wati 聊天机器人构建器。
将 Webhook 图标拖放到聊天机器人工作流中。
将其连接到相关的聊天机器人步骤。
4. Webhook 中有哪些可用的请求方法?
→ 您可以在以下方法中进行选择:
GET:从外部源检索数据。
POST:将数据发送到外部 API。
5. 我可以自定义 Webhook 请求的 URL 吗?
→ 是的。您可以使用 变量 按钮将 变量 插入到 URL 中以使请求动态化。示例:https://webhook-wa-testing.clare.ai/123456789?name=####{{name}}
自定义 Webhooks
6. 如何为 Webhook 请求添加头部?
头部是可选的 默认情况下关闭。
它们以键值对的形式设置。 示例:
键:
Content-Type
值:
application/json
7. 如何自定义 Webhook 请求的正文?
正文是可选的,默认关闭。
它必须始终以 JSON 格式 给出。
8. 测试变量是什么?为什么要使用它们?
→ 测试变量允许您手动定义值以模拟设置过程中 API 的响应。这有助于确保 Webhook 配置正确无误后才部署。
处理 API 响应
9. 如何将 API 响应保存为变量?
如果 API 响应是带有键值对的 JSON 格式,则可以通过引用键存储值。示例: 若要存储
"result": "success"
,请使用:
json { "result": "success"}
高级功能
10. 响应路由是什么?
→ 响应路由允许您根据响应状态代码拆分聊天机器人操作。您可以根据 API 响应定义不同的聊天机器人流程。
11. 可以根据 API 响应触发不同的聊天机器人流程吗?
→ 是的。通过设置响应路由,可以创建基于 API 的状态代码或特定响应值激活的多个聊天机器人流程。