contact.unsubscribe.created

使用 contact.unsubscribe.created 在您的 Webhook 终端节点处理此事件。

触发条件

在联系人退订消息时触发。在配置 Webhook 终端节点时订阅 contact.unsubscribe.created。

语法

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

{
  "id": "<ID>",
  "type": "contact.unsubscribe.created",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "unsubscriberChanged": {
    "phoneNumber": "<PHONE_NUMBER>",
    "source": "<SOURCE>",
    "updateTime": "<UPDATE_TIME>"
  }
}

参数

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

事件封包

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

事件有效载荷

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

四个通用封包字段为必填项。有效载荷字段取决于事件变体。在每个对象表格中，必填适用于其父对象存在的情况。可选字段可以省略；示例中包含某个字段并不代表该字段必填。

unsubscriberChanged

参数	类型	必填	说明
`id`	string	否	随订阅变更提供的标识符（若有）。
`phoneNumber`	string	否	采用 E.164 格式的客户电话号码。
`source`	string	否	订阅变更的来源。已知值包括 `Whatsapp`、`Inbox`、`Chatbot`、`API`、`Manual` 和 `Unknown`。请保留无法识别的值。
`updateTime`	string (date-time)	否	订阅变更的时间，采用 RFC 3339 格式。

示例

以下 JSON 是传递给您的接收端的请求体。ID、电话号码和其他账户值仅用于说明。

客户取消订阅事件

客户取消订阅时的示例有效载荷

{
  "id": "evt_3456789012",
  "type": "contact.unsubscribe.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "unsubscriberChanged": {
    "phoneNumber": "+12025550124",
    "source": "Whatsapp",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

联系人退订创建示例

{
  "id": "evt_68f8886903683f3481f9707b",
  "type": "contact.unsubscribe.created",
  "apiVersion": "v2",
  "createTime": "2025-10-22T07:31:53.872Z",
  "unsubscriberChanged": {
    "id": "68f888692abba5779b565928",
    "phoneNumber": "+12025550124",
    "source": "API",
    "updateTime": "2025-10-22T07:31:53.864Z"
  }
}

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

HTTP/1.1 200 OK

如需查看场景逐步讲解，请参阅带批注的示例。

开始使用

指南

接口

Webhook reference

contact.unsubscribe.created

触发条件

语法

参数

事件封包

事件有效载荷

unsubscriberChanged

示例

​触发条件

​语法

​参数

​事件封包

​事件有效载荷

​unsubscriberChanged

​示例

触发条件

语法

参数

事件封包

事件有效载荷

unsubscriberChanged

示例