Messenger 平台

messaging_optins Webhooks 參考資料

本文件介紹了在觸發訊息回傳 Webhook 事件時，您的 Webhooks 伺服器將會收到的 JSON 裝載。若有人點擊了「回傳」按鈕、「開始使用」按鈕或常駐選單選項，系統將會觸發回傳 Webhook 事件。

通知範例

以下範例是系統將傳送至您 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 屬性

Webhook 通知中的所有 JSON 屬性均為字串。

屬性說明

postback.mid

訊息編號

postback.payload

在 CTA payload 參數中定義的資訊。這類資訊僅包含在傳送至應用程式的 Webhook 通知中，而此等應用程式會向用戶傳送訊息。

postback.referral

用戶為進入對話所採取的動作之相關資訊。

只有在用戶使用以下其中一種方法，然後點擊 CTA（如「開始使用」按鈕）發起對話時，Webhook 通知中才會包含 referral 屬性資訊：

  • 洽談附加程式
  • m.me 連結
  • Messenger 發訊廣告
  • Messenger QR Code
  • 歡迎畫面

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

系統向伺服器傳送 Webhook 通知的日期之 UNIX 時戳

另請參閱

其他開發人員文件，讓您更詳細了解本《訊息回傳 Webhooks 指南》中提及的概念。