messages Webhook 事件參考資料

當有訊息傳送到專頁時，此回呼便會出現。系統一律會順序傳送訊息。您可能會收到文字訊息或包含附件的訊息。

image、audio、video、file、reel 和 ig_reel 是主要的支援附件類型。此外，您還可能收到 fallback 附件。一個常見的「遞補」範例為：用戶向專頁分享網址時，系統會根據連結分享建立附件。如果系統不支援用戶向專頁分享的內容，則會傳送無裝載的 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"
    }
  }
}    

包含附件的訊息

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

包含商品範本的訊息

此 Webhook 適用於用戶分享來自其他對話串的商品，或者分享流程至專頁的情況。此 Webhook 僅適用於專頁擁有的商品。應用程式將需要獲批 catalog_management 權限才能以 Webhooks 接收商品詳情。

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

包含遞補附件的訊息

以下範例適用於 v6.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（發訊廣告）並傳送訊息至 Facebook 專頁的情景。應用程式除了會收到內含的訊息詳情外，還會收到廣告轉介資料。

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

包含指令的訊息

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