messaging_postbacks Webhooks 参考文档

本文档介绍了消息回传 Webhooks 事件被触发时您 Webhooks 服务器将收到的 JSON 负载。用户点击回传按钮、“开始”按钮或固定菜单项时,会触发回传 Webhooks 事件。

通知示例

以下是将发送到您 Webhooks 服务器的 JSON 负载示例。

{
  "field": "messaging_postbacks",
  "value": {
    "sender": {
      "user_ref": "USER-REF-ID"
    },
    "recipient": {
      "id": "PAGE-ID"
    },
    "timestamp": "1527459824",
    "postback": {
      "mid": "m_MESSAGE-ID",
      "title": "TITLE-FOR-THE-CTA",
      "payload": "USER-DEFINED-PAYLOAD",
      "referral": {
        "ref": "USER-DEFINED-REFERRAL-PARAM",
        "source": "SHORT-URL",
        "type": "OPEN_THREAD"
      }
    }
  }
}

JSON 属性

Webhooks 通知中的所有 JSON 属性都是字符串。

属性描述

postback.mid

消息编号

postback.payload

CTA payload 参数中定义的信息。如果应用向用户发送了消息,则仅发送到此应用的 Webhooks 通知中才会包含此属性信息。

postback.referral

用户为进入对话而采取的操作相关信息。

仅在用户通过使用以下方式之一并点击某个行动号召 (CTA)(如“开始”按钮)开始对话时,Webhooks 通知中才会包含 referral 属性信息:

  • 聊天插件
  • m.me 链接
  • Messenger 直达广告
  • Messenger 二维码
  • 欢迎页面

postback.referral.ref

原本通过附加至 m.me 链接的 ref 参数传递的任意数据。仅支持使用字母数字字符以及 -、_ 和 =

postback.referral.source

此转介的网址。对于 m.me 链接,来源值为 “SHORTLINK”。对于来自 Messenger 对话广告的转介,来源值为 "ADS"

postback.referral.type

此转介的标识符。对于来自 m.me 链接的转介,此值一律为 "OPEN_THREAD"

postback.title

用户所点击的行动号召 (CTA) 标题

recipient.id

您的 Facebook 公共主页编号

sender.user_ref

采取某种操作(如点击“开始”按钮、聊天插件或固定菜单项)并发送了消息的用户的转介编号

timestamp

Webhooks 通知发送到您服务器当天的 Unix 时间戳

另请参阅

更多开发者文档,以进一步了解本消息回传 Webhooks 指南中提到的各种概念。