API 参考
接收事件

标准事件类型与载荷

每次投递携带的统一信封,以及全部标准事件类型目录。按端点用 subscribed_events 订阅(使用下方的精确名称),或用 ["*"] 订阅全部。信封固定为 id / type / provider / account_id / occurred_at / data;data 的结构取决于 type。

事件载荷

{
  "id": "evt_2f9c1a4b7e",
  "type": "message.received",
  "provider": "whatsapp",
  "account_id": "acc_8c21d0",
  "occurred_at": "2026-06-08T12:34:56Z",
  "data": {
    "account": { "provider_account_ref": "8613800138000" },
    "conversation": { "id": "8613912345678", "type": "user", "title": "Jordan Lee" },
    "sender": { "id": "8613912345678", "name": "Jordan Lee", "type": "user" },
    "message": {
      "id": "wamid.HBgM",
      "text": "Hi - is my order shipped yet?",
      "direction": "inbound",
      "sent_at": "2026-06-08T12:34:55Z"
    }
  }
}

标准事件类型

备注

  • 对于媒体消息,data.message.attachments[] 携带临时签名的 OSS url,以及 type、mimetype、size。
  • subscribed_events 必须填上面的精确事件名或 ["*"]。创建或更新端点时,未知名称会被拒绝。
  • 并非每个 provider 都发出全部事件,部分载荷字段也有差异——按 provider 的差异见「Webhook 标准事件差异」矩阵。
  • message.read 与 message.delivered 携带精确的回执范围:data.message.ids 列出本次回执覆盖的全部消息,read_at / delivered_at 给出渠道上报的时间。
  • WhatsApp 入站消息携带 data.message.reply_token——把它原样放入 POST /v1/messages 的 reply_to.reply_token 即可发送引用回复。若以后要回复,请随消息一起存下来。