messages Webhook 事件参考文档

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

支持的主要附件类型包括 image、audio、video、file、reel、ig_reel、post、ig_post 和 appointment_booking。您可能还会收到 fallback 附件。“fallback”的常见示例是当用户向公共主页分享网址时，系统会根据链接分享创建附件。如果用户向您的公共主页分享时，系统不支持该分享，可能会发送没有 Payload 的 fallback。

如要订阅此回调，您可以在设置 Webhook 时选择 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",
      "is_self_reply": false
    }
  }
}    

包含附件的消息

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

包含预约的消息

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

包含帖子附件的消息

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

包含产品模板的消息

此 Webhook 应用于以下情况：用户向公共主页分享来自其他帖子或共享流程的产品。此 Webhook 仅限于公共主页拥有的产品。应用将需要具备获准在 Webhook 中接收产品详情的 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"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

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

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

包含广告推荐信息的消息

该 Webhook 适用于以下情况：用户点击 CTM（Messenger 直达）广告并向 Facebook 公共主页发送消息时。除了包含的消息详情，应用程序还会收到广告推荐信息。

要求

包含广告推荐信息的消息要求应用程序必须订阅公共主页的 messages 和 messaging_referrals 字段。

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "ref": "<REF_DATA_IF_SPECIFIED_IN_THE_AD>",
      "ad_id": "<ID_OF_THE_AD>",
      "source": "ADS",
      "type": "OPEN_THREAD",
      "ads_context_data": {
        "ad_title": "<TITLE_OF_THE_AD>",
        "photo_url": "<URL_OF_THE_IMAGE_FROM_AD_THE_USER_IS_INTERESTED_IN>",
        "video_url": "<THUMBNAIL_URL_OF_THE_VIDEO_FROM_THE_AD>",
        "post_id": "<ID_OF_THE_POST>",
        "product_id": "<PRODUCT_ID>",
        "flow_id": "<ID_OF_THE_PARTNER_APP_WELCOME_MESSAGE_FLOW>"
      }
    }
  }
}

有关流程编号的详情，请参阅欢迎消息流程。

包含命令的消息

{
  "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

recipient

message

message.quick_reply

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

message.reply_to

message.attachments

message.attachments.payload

message.attachments.payload.product.elements

message.referral

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

message.referral.product

message.referral.ads_context_data

message.commands