whatsapp.meta_business_agent.handover.updated

在您的 Webhook 端点中使用 whatsapp.meta_business_agent.handover.updated 来处理此事件。

触发条件

当支持的移交回调将控制权从 Public REST API Agent 转移时触发。不确认收件箱分配。在您配置 Webhook 端点时订阅 whatsapp.meta_business_agent.handover.updated。此事件仅限于通过 Public REST API 接入的 Agent。它报告从 Agent 转移的控制权。不确认收件箱分配。

语法

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

{
  "id": "<ID>",
  "type": "whatsapp.meta_business_agent.handover.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappMetaBusinessAgent": {
    "agentId": "<AGENT_ID>",
    "metaAgentId": "<META_AGENT_ID>",
    "phoneNumberId": "<PHONE_NUMBER_ID>",
    "wabaId": "<WABA_ID>",
    "consumerPhoneNumber": "<CONSUMER_PHONE_NUMBER>",
    "controlState": "<CONTROL_STATE>",
    "actor": "<ACTOR>",
    "reason": "<REASON>",
    "timestamp": "<TIMESTAMP_VALUE>"
  }
}

参数

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

事件信封

参数	类型	必填	描述
`id`	string	是	事件的唯一 ID。最小长度：`6`。最大长度：`128`。
`type`	string	是	始终为 `whatsapp.meta_business_agent.handover.updated`。
`apiVersion`	string	是	用于渲染此事件的 API 版本。
`createTime`	string (date-time)	是	此事件创建的时间，格式遵循 RFC 3339。例如：`2022-06-01T12:00:00.000Z`。

事件载荷

参数	类型	必填	描述
`whatsappMetaBusinessAgent`	object	是	特定于事件的 `whatsappMetaBusinessAgent` 载荷。

四个通用信封字段为必填项。载荷字段取决于事件变体。在每个对象表格中，必填在其父对象存在时适用。可选字段可省略；示例中的字段并不意味着必填。

whatsappMetaBusinessAgent

参数	类型	必填	描述
`agentId`	string	否	YCloud Agent ID。不是 Meta Agent ID 或收件箱被分配人 ID。
`metaAgentId`	string	否	Meta Agent ID（若可用）。
`phoneNumberId`	string	否	Meta 商业电话号码 ID。不是 E.164 格式电话号码。
`wabaId`	string	否	来自源回调的 WhatsApp 商业账户 ID（若可用）。
`consumerPhoneNumber`	string	否	来自移交回调的客户电话号码，若可用则规范化为 E.164 格式。这不是商业电话号码或 phoneNumberId。模式：`^+[1-9][0-9]{7,14}$`。
`controlState`	string	否	存在于移交事件中。目前针对 Public REST API 移交回调为 APP_CONTROL_TAKEN。不确认收件箱分配或消息送达。
`actor`	string	否	可选的移交来源参与者。对于 control_passed 移交，这是前一个所有者应用 ID，而不是接收该会话的员工。
`reason`	string	否	可选的提供商移交原因或元数据，例如 customer_request。非封闭枚举。
`timestamp`	integer (int64)	否	Unix 毫秒格式的源事件时间，若不可用则为处理时间。

示例

以下 JSON 是传递给您的接收器的请求体。ID、电话号码和其他账户值仅作演示说明。 APP_CONTROL_TAKEN 报告控制权转移，而非收件箱员工分配或自定义移交消息的送达。在此示例中，actor 是前一个所有者应用 ID。

{
  "id": "evt_example_agent_handover",
  "type": "whatsapp.meta_business_agent.handover.updated",
  "apiVersion": "v2",
  "createTime": "2026-09-09T02:00:04.000Z",
  "whatsappMetaBusinessAgent": {
    "agentId": "00000000-0000-4000-8000-000000000001",
    "metaAgentId": "META_AGENT_ID",
    "phoneNumberId": "PHONE_NUMBER_ID",
    "wabaId": "WABA_ID",
    "consumerPhoneNumber": "+12025550124",
    "controlState": "APP_CONTROL_TAKEN",
    "actor": "PREVIOUS_OWNER_APP_ID",
    "reason": "customer_request",
    "timestamp": 1788919204000
  }
}

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

HTTP/1.1 200 OK

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

开始使用

指南

接口

Webhook reference

whatsapp.meta_business_agent.handover.updated

触发条件

语法

参数

事件信封

事件载荷

whatsappMetaBusinessAgent

示例

​触发条件

​语法

​参数

​事件信封

​事件载荷

​whatsappMetaBusinessAgent

​示例

触发条件

语法

参数

事件信封

事件载荷

whatsappMetaBusinessAgent

示例