messages Webhooks 事件参考文档

当消息发送至公共主页时,便会发生此回调。系统会一律按照顺序发送消息。您可能会收到文本消息或者带有附件的消息。

主要支持的附件类型包括 imageaudiovideofilereel。您可能还会收到 fallback 附件。“fallback”的常见示例是当用户向公共主页分享网址时,系统会根据链接分享创建附件。如果用户向您的公共主页分享时,系统不支持该分享,可能会发送没有负载的 fallback

如要订阅此回调,您可以在设置 Webhooks 时选择 message

示例

文本消息

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "quick_reply": {
      "payload": "<DEVELOPER_DEFINED_PAYLOAD>"
    }
  }
}    

回复消息

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"m_1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "reply_to": {
      "mid":"m_1fTq8oLumEyIp3Q2MR-aY7IfLZDamVrALniheU"
    }
  }
}    

包含附件的消息

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

包含产品模板的消息

包含产品模板的消息 Webhooks 仅适用于图谱 API 8.0 以上版本

此 Webhooks 应用于以下情况:用户向公共主页分享来自其他帖子串或共享流程的产品。此 Webhooks 仅限于公共主页拥有的产品。应用将需要具备获准在 Webhooks 中接收产品详情的 catalog_management 权限。

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

包含 fallback 附件的消息

适用于版本 6.0 以上的 messages 的示例

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGE_ID>",
            "time": 1583173667623,
            "messaging": [
                {
                    "sender": {
                        "id": "<PSID>"
                    },
                    "recipient": {
                        "id": "<PAGE_ID>"
                    },
                    "timestamp": 1583173666767,
                    "message": {
                        "mid": "m_toDnmD...",
                        "text": "This is where I want to go: https:\/\/youtu.be\/bbo_fZAjIhg",
                        "attachments": [
                            {
                                "type": "fallback",
                                "payload": {
                                    "url": "<ATTACHMENT_URL >",
                                    "title": "TAHITI - Heaven on Earth"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

来自店铺商品详情页面的消息

来自店铺商品详情页面的消息 Webhooks 仅适用于图谱 API 8.0 以上版本

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "product": {
        "id":"<PRODUCT_ID>"
      }
    }
  }
}    

包含命令的消息

{
  "object": "page",
  "entry": [
    {
      "id": "<PAGE_ID>",
      "time": 1697643211842,
      "messaging": [
        {
          "sender": {
            "id": "<PSID>"
          },
          "recipient": {
            "id": "<PAGE_ID>"
          },
          "timestamp": 1697643027400,
          "message": {
            "mid": "m_3vs...",
            "text": "find flights from SFO to LAX next Thursday",
            "commands": [
              {
                "name": "flights"
              }
            ]
          }
        }
      ]
    }
  ]
}

属性

sender

属性类型描述

id

字符串

触发 Webhook 事件的用户 PSID。

user_ref

字符串

触发 Webhook 事件的用户 user_ref。此属性仅适用于聊天插件的 Webhook 事件。

recipient

属性类型描述

id

字符串

您的主页编号。

message

2020 年 3 月 4 日公告

在 6.0 以上版本中,sticker_idmessage 移动至 message.attachments.payload

属性 类型 描述

mid

字符串

消息编号

text

字符串

消息文本

quick_reply

对象

由发送消息的应用提供的可选自定义数据

reply_to

对象

对此消息回复的消息编号 (mid) 的参照

attachments

数组<attachment>

包含附件数据的数组

referral

对象

来自店铺商品详情页消息的推荐。

message.quick_reply

如果用户轻触快速回复按钮,系统提供的 quick_reply 负载中仅包含文本消息。

属性 类型 描述

payload

字符串

由应用提供的自定义数据

message.reply_to

属性 类型 描述

mid

字符串

对此消息回复的消息编号的参照

message.attachments

属性 类型 描述

type

字符串

audiofileimagevideofallbackreel

payload

字符串

message.attachments.payload

message.attachments.payload

属性 类型 描述

url

字符串

附件类型的网址。适用于以下附件类型:audiofileimagevideofallbackreel

title

字符串

附件的标题。适用于以下附件类型:fallbackreel

sticker_id

数字

此贴图的永久编号,例如 369239263222822 引用“赞”贴图。适用于以下附件类型:image(仅当发送贴图时适用)。

reel_video_id

数字

与所附 Reels 相关的视频编号。适用于以下附件类型:reel

message.attachments.payload.product.elements

属性 类型 描述

id

字符串

Facebook 商品目录上的商品编号

retailer_id

字符串

与商品关联的外部编号。(例如:SKU 或内容编号)

image_url

字符串

商品网址

title

字符串

商品标题

subtitle

字符串

商品副标题

message.referral

仅当用户在店铺商品详情页面发送消息时,系统才会提供 referral 负载。

属性 类型 描述

product

对象

商品信息

message.referral.product

属性 类型 描述

id

字符串

商品编号

message.commands

属性 类型 描述

name

字符串

命令名称