Messenger 開放平台

messaging_postbacks 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 屬性

Webhooks 通知中的所有 JSON 屬性都是字串。

屬性說明

postback.mid

訊息的編號

postback.payload

CTA payload 參數中定義的資訊。這只會包含在傳送訊息給用戶之應用程式所收到的 Webhook 通知中。

postback.referral

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

唯有當用戶透過下列其中一種方式，點擊「開始使用」按鈕之類的 CTA 來開始對話時，才會在 Webhook 通知中包含 referral 屬性資訊：

  • 洽談外掛程式
  • m.me 連結
  • Messenger 發訊廣告
  • Messenger QR 碼
  • 歡迎畫面

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 指南中提到的概念，請參閱以下開發人員文件。