Skip to main content

功能介绍

此目录涵盖了 OpenAPI 规范中的全部 47 种 Webhook 事件类型,并保留了每个具名的有效负载示例。

运作方式

根据确切的 type 选择事件,展开示例,并使用该有效负载在 Webhook 接收端中测试路由、反序列化、幂等性以及异步处理。

请求

每个示例均为 YCloud 发送的 HTTP POST 请求的 JSON 主体。该请求还包含一个 YCloud-Signature 请求头,在信任该有效负载之前您必须对其进行验证。

响应

在您的应用程序持久化接收该事件后,返回 2xx 响应。
有关事件触发条件、有效负载字段和示例,请浏览 Webhook 示例。

有效负载目录

使用 messengerInboundMessage.id 关联重复的客户消息;保留文本空白字符。
同一条已保存的消息现在携带最新的文本及累计编辑详情。
使用消息 ID 关联快照;省略未知的中间接收时间。
目标 Meta 消息无需在 YCloud 本地拥有消息记录。
撤回操作可以省略回应名称和表情符号。
存储来自 whatsappMessage.text.body 的文本。id 和 wamid 用于关联后续的状态事件。
消息内容因类型而异。请将媒体 ID 视为服务商引用,而非公开下载 URL。
通过 id 或 wamid 与已创建事件进行关联。更新事件会省略消息内容和类型。
通过 id 或 wamid 与已创建事件进行关联。更新事件会省略消息内容和类型。
优先级较低的源状态可能会在已读后送达。记录该事件即可,无需将当前消息状态降级。
这是一条单独的失败消息,并非从已读状态转变而来。失败更新会在可用时包含源错误详情。
APP_CONTROL_TAKEN 报告的是控制权移交,而非收件箱员工分配或自定义转接消息的送达。本示例中的 actor 为上一个所有者应用的 ID。
读取 whatsappBusinessAccount.id 以识别该账户。存在时,removedReason、removedInitiatedBy 和 removedTime 会描述移除详情。请保留未知的 reason 和 initiator 值。
从 whatsappPhoneNumber 读取 qualityRating 和 qualityUpdateEvent。messagingLimit 描述电话号码层级;whatsappBusinessManagerMessagingLimit 描述所属商业管理资产组合的限额。
联系人属性变更时的有效负载示例
创建新联系人时的有效负载示例
删除联系人时的有效负载示例
仅在单独删除备注时触发,联系人级联删除时不触发。
客户取消订阅时的有效负载示例
客户恢复订阅时的有效负载示例
WhatsApp 电话号码商业用户名生效时的有效负载示例
WhatsApp 电话号码拥有预留商业用户名请求时的示例有效负载
Meta 在 Utility Direct Send 消息中检测到了营销内容。可通过 Webhook 端点 API 订阅此事件。
由于多次滥用类别,Meta 对 Utility Direct Send 进行了为期 7 天的限制。
WhatsApp 模板被归档时的示例有效负载
WhatsApp 模板被取消归档时的示例有效负载。模板状态是 Meta 返回的当前状态,并不代表新的审核批准。
WhatsApp 通话接通时的示例有效负载
WhatsApp 通话终止时的示例有效负载
WhatsApp 通话状态更新时的示例有效负载
源自 API 的通话录音可用时的示例有效负载
源自 API 的通话转录永久失败时的示例有效负载
WhatsApp 群组创建时的示例有效负载
添加 WhatsApp 群组成员时的示例有效负载
WhatsApp 群组设置更新时的示例有效负载
WhatsApp 群组封禁状态变更时的示例有效负载
从 whatsappMessage 中读取出站消息。消息类型决定其内容对象;此示例包含文本。
此事件用于同步从 WhatsApp Business 应用程序或受支持的配套设备发送的消息。从 whatsappMessage 中读取其内容。
入站历史消息使用 whatsappInboundMessage。phase 和 progress 报告历史分块的同步情况。
出站历史消息使用 whatsappMessage。请勿将其作为入站消息路由。
仅包含元数据的历史分块会报告 phase 和 progress,而不包含任何一个消息对象。请勿将此结构视为 message-created 或 message-echoes 有效负载。