Skip to main content
有关从 Schema 衍生的完整目录,请参阅所有示例。

概述

处理 WhatsApp 通话状态更新。

准备工作

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

工作原理

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

请求

以下场景展示了发送到您的 Webhook URL 的请求。请将事件 id 视为传递标识符,并使用 type 路由有效载荷。

响应

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

当企业向 WhatsApp 用户发起通话时,会收到包含通话状态的 Webhook 通知:RINGING、ACCEPTED 或 REJECTED。

企业发起的通话正在响铃

当 WhatsApp 用户的客户端设备开始响铃时:

请求

响应

在持久化接收事件后确认交付。

说明

按 type 路由事件,按 id 进行去重,并将耗时或易出错的任务移至异步处理器。

企业发起的通话已被用户接听

当 WhatsApp 用户接听通话时:

请求

响应

在持久化接收事件后确认交付。

说明

按 type 路由事件,按 id 进行去重,并将耗时或易出错的任务移至异步处理器。

企业发起的通话被用户拒绝

当通话被 WhatsApp 用户拒绝时。在此情况下,您还会收到通话终止 Webhook 通知:

请求

响应

在持久化接收事件后确认交付。

说明

按 type 路由事件,按 id 进行去重,并将耗时或易出错的任务移至异步处理器。