Messenger 開放平台

message_echoes Webhook 事件參考資料

粉絲專頁傳送訊息後，就會發生這項回呼。您可能會收到 text 訊息或含附件的訊息（image、video、audio、template 或 fallback）。承載會同時包含傳送者所傳送的選用自訂 metadata 和對應的 app_id。
當您設定 Webhook 時，可以選擇 message_echoes 欄位，用於訂閱這項回呼。

支援多種訊息類型：

常用格式

範例 1

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    ...
  }
}

範例 2

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGEID>",
            "time": 1570053170926,
            "standby": [
                {
                    "sender": {
                        "id": "<PAGEID>"
                    },
                    "recipient": {
                        "id": "<PSID>"
                    },
                    "timestamp": 1570053170673,
                    "message": {
                        "mid": "qT7ywaKpO9kkQR7Gv-nM8LIfLZDamVrALniheUYEDdHJXjDXEAyaS1xxONzb2Iv-DFzmTihfWJV012P5pK0AhQ",
                        "is_echo": true,
                        "app_id": <APPID>,
                        "attachments": [
                            {
                                "title": "",
                                "url": "https:\/\/www.facebook.com\/commerce\/update\/",
                                "type": "template",
                                "payload": {
                                    "template_type": "media",
                                    "elements": [
                                        {
                                            "media_type": "image",
                                            "attachment_id": 2457235337685388
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

屬性

sender

屬性型別說明

id

字串

觸發 Webhook 事件的用戶 PSID。

user_ref

字串

觸發 Webhook 事件的用戶 ser_ref，僅適用於洽談外掛程式的 Webhook 事件。

recipient

屬性型別說明

id

字串

您的粉絲專頁編號。

message

欄位名稱 類型 說明

is_echo

布林值

表示從粉絲專頁傳送的訊息

app_id

字串

傳送訊息的應用程式編號。從圖形 API v12.0+ 開始，只要訊息是經由 Facebook 粉絲專頁收件匣傳送的 app_id 欄位會傳回 Facebook 粉絲專頁收件匣應用程式編號（26390203743090）。

metadata

字串

傳遞至傳送 API 做為 metadata 欄位的自訂字串。只有在原始訊息中已設定 metadata 屬性時才出現。

mid

字串

訊息編號

文字訊息

範例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!"
  }
}

屬性

message

屬性 類型 說明

text

字串

訊息文字

含圖像、音訊、影片或檔案附件的訊息

範例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"image",
        "payload":{
          "url":"<IMAGE_URL>"
        }
      }
    ]
  }
}

屬性

message.attachments

屬性 類型 說明

type

字串

附件類型：image、audio、video 或 file

payload.url

字串

附件網址

含範本附件的訊息

範例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "template_type":"button",
          "buttons":[
            {
              "type":"web_url",
              "url":"https:\/\/www.messenger.com\/",
              "title":"Visit Messenger"
            }
          ]
        }
      }
    ]
  }
}

屬性

message.attachments

屬性 類型 說明

type

字串

template

payload

字串

傳送 API 參考資料中所述的範本承載

請注意，若是含附件的 payload，所傳送的附件編號是數字而不是字串。請參閱範例 2

這與需要將附件編號以字串傳送的傳送 API 格式不符。

含遞補附件的訊息

遞補附件是 Message Echo（訊息回應）功能目前無法識別或支援的附件。

範例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "title":"Legacy Attachment",
        "url":"https:\/\/www.messenger.com\/",
        "type":"fallback",
        "payload":null
      }
    ]
  }
}

屬性

message.attachments

屬性 類型 說明

type

字串

fallback

title

字串

附件標題（選用）

url

字串

附件網址（選用）

payload

字串

附件承載（選用）

含產品的訊息

含產品回應 Webhook 的訊息只適用於圖形 API v8.0 以上版本

應用程式將需要具有核准的 catalog_management 權限，才能在 Webhooks 中接收產品詳細資料。

範例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "product":{
             "elements":[ // multiple elements for Hscroll
               {
                 "id":"<PRODUCT_ID>",
                 "retailer_id":"<EXTERNAL_ID>",
                 "image_url":"https://fb.cdn.com/sdsd",
                 "title":"Some product title",
                 "subtitle": "40",
               },
               {...},
             ]
            }

          ]
        }
      }
    ]
  }
}

屬性

product.elements

屬性 類型 說明

id

字串

商品目錄中的產品編號

retailer_id

字串

與產品相關聯的外部編號。（例如：SKU／內容編號）

image_url

字串

產品圖像網址

title

字串

產品標題

subtitle

字串

產品副標題