如需查看基于 Schema 生成的完整目录,请参阅所有示例。
功能简介
处理 WhatsApp 群组创建和删除结果。准备工作
- 在您的应用程序中创建一个公开的 HTTPS 端点。
- 为您所需的事件类型配置 YCloud Webhook 端点。
- 安全存储端点签名密钥。
- 确保事件处理具备幂等性。
工作原理
事件发生时,YCloud 会发送 HTTPPOST 请求。请验证签名、持久化记录事件、返回 2xx 响应,并异步处理耗时操作。
请求
以下场景展示了发送至您的 Webhook URL 的请求。将事件id 作为投递标识符,并使用 type 对载荷进行路由。
响应
接收事件后返回2xx 状态。
有关端点设置、签名验证和重试机制的详细信息,请参阅配置 Webhook。
群组已创建
成功创建 WhatsApp 群组后,您将收到具有以下载荷结构的 Webhook:请求
响应
在持久化接收事件后确认投递。说明
根据type 路由事件,使用 id 进行去重,并将耗时或易出错的操作移至异步处理器。
群组已删除
删除 WhatsApp 群组后,您将收到具有以下载荷结构的 Webhook:请求
响应
在持久化接收事件后确认投递。说明
- type:群组生命周期事件始终为
whatsapp.group.lifecycle_update - whatsappGroup:包含群组生命周期结果详情
- field:始终为
group_lifecycle_update - type:生命周期操作,例如
group_create或group_delete - requestId:异步群组 API 操作返回的请求 ID
- status:归一化后的结果状态,例如
created、deleted或failed - groupId:WhatsApp 群组 ID
- inviteLink:群组邀请链接,在群组创建成功时包含
- dedupeKey:用于对群组生命周期 Webhook 事件进行去重的幂等键
- field:始终为

