Webhooks 事件参考文档

发生各种互动或事件时(包括用户发送消息时),Messenger 开放平台会通过 Webhooks 事件来通知您的智能助手。Messenger 开放平台会以 POST 请求的形式,将 Webhooks 事件发送至您的 Webhooks。

注意:您需要为企业的所有消息应用订阅消息 Webhooks。

Webhooks 事件列表

以下列表中列出了 Messenger 开放平台可向 Webhooks 发送的事件。

注意:建议您使用最新版 API 来接收每个 Webhooks 的所有可用信息。

Webhook 事件说明

messages

订阅消息接收事件

messaging_account_linking

订阅帐户绑定事件

messaging_checkout_updates(公测版)

订阅结账更新事件

message_deliveries

订阅消息送达事件

message_echoes

订阅消息回传事件

messaging_game_plays

订阅小游戏事件

messaging_handovers(公测版)

订阅移交协议事件

messaging_optins

订阅插件选择加入事件

messaging_payments(公测版)

订阅支付事件

messaging_policy_enforcement

订阅政策执行事件

messaging_postbacks

订阅回传接收事件

messaging_pre_checkouts(公测版)

订阅支付预结账事件

message_reads

订阅消息读取事件

messaging_referrals

订阅推荐来源事件

standby(公测版)

订阅移交协议备用通道事件

事件格式

Messenger 开放平台的所有回调都使用相同的一组属性,这些属性能提供必要信息,以便您处理和回复用户利用智能助手发送的消息。除了以下属性外,每个事件还有用于详细说明事件本身的一组独有属性。

{
  "object":"page",
  "entry":[
    {
      "id":"<PAGE_ID>",
      "time":1458692752478,
      "messaging":[
        {
          "sender":{
            "id":"<PSID>"
          },
          "recipient":{
            "id":"<PAGE_ID>"
          },

          ...
        }
      ]
    }
  ]
}

属性

属性 类型 描述

object

字符串

值为 page

entry

entry 数组

包含事件数据的数组

entry

属性 类型 描述

id

字符串

公共主页编号

time

数字

更新时间(新纪元时间,以毫秒表示)

messaging

<messaging> 数组

包含一个 messaging 对象的数组。请注意,虽然这是一个数组,但只包含一个 messaging 对象。

entry.messaging

属性 类型 描述

sender.id

字符串

发送人的用户编号

recipient.id

字符串

接收人的用户编号

详细了解

如果有多个应用来处理消息,例如一个应用处理自动回复,一个应用处理向人工客服的上报,您将需要实施移交协议,这样才能将对话从一个应用传递到另一个应用。移交协议