Skip to main content
如需查看完整的 Schema 衍生目录,请参阅所有示例。

概述

浏览特定事件的 Webhook 演练、前置条件和 Payload 示例。

准备工作

  • 在您的应用程序中创建一个公开的 HTTPS 端点。
  • 为您所需的事件类型配置 YCloud Webhook 端点。
  • 安全存储端点签名密钥。
  • 确保事件处理具备幂等性。

工作原理

当事件发生时,YCloud 会发送 HTTP POST 请求。验证签名,持久化记录事件,返回 2xx 响应,并异步处理耗时任务。

请求

以下场景展示了发送至您的 Webhook URL 的请求。将事件 id 作为投递标识符,并使用 type 路由 Payload。

响应

接收事件后返回 2xx 状态。
有关端点设置、签名验证和重试机制,请参阅配置 Webhook。

消息与模板事件

模板审核

处理已批准、已拒绝、已暂停、已停用和已归档的模板状态。

消息状态

处理出站消息的已发送、已送达、已读和失败状态。

入站消息

解析文本、媒体、位置、联系人、互动、商业和系统消息。

支付更新

处理 WhatsApp 支付交易变更。

回响与 Agent 交接事件

对于通过公开 REST API 接入的 Agent,请使用这些特定事件的演练。 通过控制台创建的 Agent 使用独立的收件箱同步流程。

回响消息已创建

存储出站文本和媒体回响。

回响消息已更新

处理已送达、已读、延迟发送和失败的状态更新。

Agent 交接已更新

监控控制权交接并了解其关联限制。

账户、应用与 Flow 事件

商业账户更新

处理资格、位置、违规、限制和账户状态变更。

Business App 历史记录

同步历史入站和出站消息。

Business App 消息回响

同步从 WhatsApp Business App 发送的消息。

Flow 状态

处理 Flow 生命周期状态变更。

通话与群组事件

通话连接

处理 WhatsApp 通话的 SDP Offer 和 Answer。

通话状态

处理响铃、已接听和已拒绝的通话状态。

通话终止

处理已完成和已失败的通话终止。

群组生命周期

处理群组创建和删除。

群组成员

处理成员及加群申请变更。

群组设置

处理群主题和群描述变更。

群组状态

处理群组封禁与恢复。

联系人事件

联系人已创建

处理新创建的联系人。

联系人已删除

移除或对账已删除的联系人。

联系人属性已更改

处理个人资料、自定义属性和标签的变更。

联系人已退订

处理新创建的退订记录。

联系人已重新订阅

处理已删除的退订记录。

打开完整的 Payload 目录

浏览 OpenAPI 规范中的所有事件类型和全部已命名的 Payload 示例。