whatsapp.phone_number.deleted

在您的 Webhook 端点使用 whatsapp.phone_number.deleted 处理此事件。

触发条件

在 WhatsApp 商业电话号码被删除时触发。配置您的 Webhook 端点时订阅 whatsapp.phone_number.deleted。

语法

YCloud 会向您配置的 Webhook URL 发送 HTTP POST 请求。以下结构展示了一种有效负载变体。尖括号中的值为占位符；其类型列在参数下。可选字段和其他变体在下文说明。

{
  "id": "<ID>",
  "type": "whatsapp.phone_number.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappPhoneNumber": {
    "id": "<ID>",
    "phoneNumber": "<PHONE_NUMBER>",
    "wabaId": "<WABA_ID>"
  }
}

参数

在处理 JSON 请求体之前，请先验证 YCloud-Signature HTTP 请求头。请参阅签名验证。

事件外层结构

参数	类型	必填	说明
`id`	string	是	事件的唯一 ID。最小长度：`6`。最大长度：`128`。
`type`	string	是	固定为 `whatsapp.phone_number.deleted`。
`apiVersion`	string	是	用于呈现此事件的 API 版本。
`createTime`	string (date-time)	是	创建此事件的时间，采用 RFC 3339 格式。例如 `2022-06-01T12:00:00.000Z`。

事件有效负载

参数	类型	必填	说明
`whatsappPhoneNumber`	object	否	特定于事件的 `whatsappPhoneNumber` 有效负载。

四个通用外层字段为必填项。有效负载字段取决于具体的事件变体。在各个对象表中，必填仅在其父对象存在时适用。可选字段可以省略；示例中出现并不意味着该字段是必填项。

whatsappPhoneNumber

参数	类型	必填	说明
`id`	string	否	电话号码 ID。
`phoneNumber`	string	否	采用 E.164 格式的电话号码。
`displayPhoneNumber`	string	否	显示的电话号码。
`wabaId`	string	否	WhatsApp 商业账户 ID。
`updateEvent`	string	否	触发此电话号码状态变更的账户更新事件。可选值：`ACCOUNT_RECONNECTED`、`ACCOUNT_OFFBOARDED`。

示例

以下 JSON 是传递给接收方的请求体。ID、电话号码和其他账户值仅供参考说明。

{
  "id": "evt_example_whatsapp_phone_number_deleted",
  "type": "whatsapp.phone_number.deleted",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "whatsappPhoneNumber": {
    "id": "1234567890123456",
    "phoneNumber": "+12025550124",
    "wabaId": "whatsapp-business-account-id"
  }
}

在验证签名并持久接收事件后，请返回 2xx 响应。耗时任务请异步处理。

HTTP/1.1 200 OK

有关场景演示，请参阅带注释的示例。

开始使用

指南

接口

Webhook reference

whatsapp.phone_number.deleted

触发条件

语法

参数

事件外层结构

事件有效负载

whatsappPhoneNumber

示例

​触发条件

​语法

​参数

​事件外层结构

​事件有效负载

​whatsappPhoneNumber

​示例

触发条件

语法

参数

事件外层结构

事件有效负载

whatsappPhoneNumber

示例