Sign inGet Started

WhatsApp 入站消息 Webhook

当联系人向你发送消息时,Bird 会将 whatsapp.received 推送到你的端点。载荷使用 WhatsApp 事件信封,并包含每个消息事件都携带的字段。

接收载荷

whatsapp.received 在每个消息事件都携带的字段之上附带消息内容,端点无需回读即可处理入站消息。点击交互式消息会以 interactive_reply 的形式到达,in_reply_to_message_id 标识它所回复的消息:
代码示例
{
  "data": {
    "direction": "inbound",
    "from": {
      "display_name": "Alex Rivera",
      "phone_number": "+14155550100",
      "username": "alexr"
    },
    "in_reply_to_message_id": "wam_01ky7qbvswf3fvyaw3az90391c",
    "interactive_reply": {
      "list": {
        "description": "Next day to 2 days",
        "slug": "priority_express",
        "text": "Priority Mail Express"
      },
      "type": "list"
    },
    "metadata": null,
    "tags": null,
    "to": { "phone_number": "+13124495569" },
    "whatsapp_id": "wam_01ky8b3xq4gd7pmzn2ka51f7te",
    "workspace_id": "ws_01ky7m235keycbnwyajabe1a6b"
  },
  "timestamp": "2026-07-23T14:52:04.118Z",
  "type": "whatsapp.received"
}
其他内容分支遵循相同的多选一结构:text、image、video、audio、sticker、document、location、contact_cards,以及 unsupported(用于 API 未建模的类型)。GET /v1/whatsapp/messages/{message_id} 记录了每种类型的详情。

后续步骤