摘要
Wati 中的 Webhook 允许您通过向您的服务器发送事件数据,实时接收有关消息及其状态的更新。本指南介绍了您可以跟踪的事件、如何设置 Webhook 以及基于会话的回调是如何工作的,以便您能够在系统中可靠地处理消息活动。
操作说明
Wati Webhook 可以捕获哪些事件?
当您的 Wati 账户中发生特定事件时,Wati Webhook 会通知您的外部系统。当事件发生时,Wati 会向您配置的 Webhook URL 发送回调负载。您的系统可以使用此信息来跟踪消息、监控消息状态并随时了解 WhatsApp 账户的变化。
Wati 支持以下 Webhook 事件:
消息和对话事件
Message Received(收到消息) – 当客户发送消息时。
New Contact Message(新联系人消息) – 当新联系人发送消息时。
Session Message Sent(会话消息已发送) – 当会话消息发送时。
Template Message Sent(模板消息已发送) – 当模板消息发送时。
Sent Message is DELIVERED(已发送消息已送达) – 当已发送的消息送达时。
Sent Message is Read(已发送消息已读) – 当已发送的消息被阅读时。
Sent Message is REPLIED(已发送消息已回复) – 当客户回复已发送的消息时。
Session Message Failed(会话消息失败) – 当会话消息发送失败时。
Template Message FAILED(模板消息失败) – 当模板消息发送失败时。
模板事件
Template Status Update(模板状态更新) – 当模板状态发生变化时。
Template Quality Update(模板质量更新) – 当模板质量评级发生变化时。
Template Category Update(模板类别更新) – 当模板类别发生变化时。
WhatsApp 账户和电话号码事件
WhatsApp Account Review Updated(WhatsApp 账户审核已更新) – 当 WhatsApp 账户的审核状态发生变化时。
Phone Number Quality Update(电话号码质量更新) – 当电话号码的质量评级发生变化时。
WABA Account Deleted(WABA 账户已删除) – 当 WhatsApp Business Account (WABA) 被删除时。
WABA Account Content Updated(WABA 账户内容已更新) – 当 WABA 内容更新时。
Phone Number Deleted(电话号码已删除) – 当电话号码被删除时。
Business Capability Updated(业务能力已更新) – 当业务能力更新时。
其他事件
Chatbot Triggered(聊天机器人已触发) – 当聊天机器人被触发时。
CTA URL Clicked(CTA URL 已点击) – 当客户点击 CTA URL 时。
CTA Button Clicked (BSUID)(CTA 按钮已点击) – 当客户点击 CTA 按钮时。
Call Status(通话状态) – 当 WhatsApp 通话状态发生变化时。
Contact Request Response(联系请求响应) – 当客户响应联系请求时。
WhatsApp Payment Captured(WhatsApp 支付已获取) – 当 WhatsApp 支付成功获取时。
针对 BSUID 的其他 Webhook 事件
Wati 还支持针对 BSUID(业务范围用户 ID)的其他 Webhook 事件。
其中包括:
Message Received (BSUID)
New Contact Message (BSUID)
Session Message Sent (BSUID)
Session Message Sent v2 (BSUID)
Template Message Sent (BSUID)
Template Message Sent v2 (BSUID)
Chatbot Triggered (BSUID)
CTA Button Clicked (BSUID)
Call Status (BSUID)
有关各个事件及其回调负载的详细信息,请参阅我们的 Webhook 文档。
如何在 Wati 中添加 Webhook
按照以下步骤设置 Webhook:
登录您的 Wati 控制面板。
转到 Connectors(连接器)并点击 Webhooks。
点击 Add Webhook(添加 Webhook)。

输入您的完整 Webhook URL。
将状态设置为 Enabled(已启用)。Webhook 状态可以是 Enabled(已启用)、Disabled(已禁用)和 Defective(有缺陷)。
选择您想要捕获的事件。

点击 Save(保存)。
如何测试您的 Webhook
添加 Webhook 后,您可以测试连接:
使用 Trigger sample callback(触发示例回调)选项。

Wati 将向您的 Webhook URL 发送示例负载。

验证您的服务器是否正确接收并处理了该负载。
了解基于会话的 Webhook
在 WhatsApp Business API 中,对话以 24 小时会话的形式进行跟踪。会话在企业消息送达时开始。
会话类型
Active session(活跃会话)
企业和客户至少交换了一条消息。
示例:企业发送模板消息,客户进行了回复。
Inactive session(非活跃会话)
仅一方发送了消息,而另一方尚未回应。
示例:企业发送模板消息,但客户没有回复。
注意:Webhook 回调可能会根据会话是活跃还是非活跃而有所不同。
Webhook 响应和重试逻辑
为确保可靠交付,您的 Webhook 必须正确响应。
您的服务器必须返回
200 OK响应,以确认已接收到该事件。
如果未收到
200响应:Wati 将重试发送该事件。
重试次数最多可达 144 次。
重试尝试以 10 分钟为间隔进行。
如果有超过 100 次连续失败:
该 Webhook 将被标记为 Defective(有缺陷)。
您将收到一封电子邮件通知。
如果所有重试尝试均失败,该事件将不再发送。
最佳实践
确保您的 Webhook 端点始终可用且响应迅速。
记录传入的负载以便于调试。
处理重复事件,因为重试可能会多次发送相同的负载。
验证传入的请求,确保它们来自 Wati。
此设置有助于使您的系统与 Wati 中的实时消息活动保持同步。
常见问题解答 (FAQ)
Webhook 事件和配置
1. Wati Webhook 可以捕获哪些类型的事件?
Wati Webhook 可以捕获消息和对话事件、模板事件、WhatsApp 账户和电话号码事件以及其他事件。当支持的事件发生时,Wati 会向您配置的 Webhook URL 发送回调负载。
2. Wati 中有哪些可用的 Webhook 状态?
Wati 支持三种 Webhook 状态:
Enabled(已启用) – Webhook 已启用。
Disabled(已禁用) – Webhook 已禁用。
Defective(有缺陷) – Webhook 因多次交付失败而被标记为有缺陷。
3. Wati 是否支持针对 BSUID 的其他 Webhook 事件?
是的。Wati 支持针对业务范围用户 ID (BSUID) 的其他 Webhook 事件。有关各个 BSUID 事件及其回调负载的详细信息,请参阅 Webhook 文档。
基于会话的 Webhook
4. 活跃会话和非活跃会话有什么区别?
活跃会话是指企业和客户至少交换了一条消息的情况。
非活跃会话是指只有一方发送了消息,而另一方尚未回应的情况。
5. Webhook 回调在活跃和非活跃会话之间会有所不同吗?
是的。Webhook 回调可能会根据 WhatsApp 会话是处于活跃还是非活跃状态而有所不同。WhatsApp 会话在企业消息送达时开始,并持续 24 小时。
Webhook 响应和故障排除
6. 如果我的 Webhook 端点没有返回 200 OK 响应会怎样?
您的服务器必须返回 200 OK 响应以确认已接收到 Webhook 事件。如果 Wati 未收到此响应,它将以 10 分钟为间隔重试发送该事件,最多重试 144 次。
如果连续失败超过 100 次,Wati 会将 Webhook 标记为 Defective(有缺陷)并发送电子邮件通知。如果所有重试尝试均失败,Wati 将停止发送该事件。
7. 我该如何提高 Webhook 的可靠性?
保持您的 Webhook 端点可用且响应迅速,记录传入的回调负载以便于调试,处理重复事件以避免多次处理同一负载,并验证传入的请求以确保它们来自 Wati。
Did this answer your question?