Messengerプラットフォーム

messaging_postbacks Webhooksのリファレンス

このドキュメントでは、メッセージポストバックWebhooksイベントがトリガーされたときに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

メッセージのID

postback.payload

CTA payloadパラメーターで定義されている情報。これは、メッセージを相手に送信したアプリが受け取ったWebhooks通知にのみ含まれます。

postback.referral

会話に入るために相手が取ったアクションに関する情報。

referralプロパティ情報は、次のいずれかを使用して相手が会話を開始し、それからスタートボタンなどのCTAをクリックしたときのWebhooks通知にのみ含まれます。

  • チャットプラグイン
  • m.meリンク
  • Messenger誘導広告
  • Messenger QRコード
  • ウェルカム画面

postback.referral.ref

最初にrefパラメーターで渡された任意のデータがm.meリンクに追加されます。使用できる文字は英数字および「-」、「_」、「=」のみです

postback.referral.source

このリファーラルのURL。m.meリンクの場合、ソースの値は“SHORTLINK”になります。Messengerスレッド広告からのリファーラルの場合、ソースの値は"ADS"になります

postback.referral.type

当該リファーラルの識別情報。m.meリンクからのリファーラルの場合、常に"OPEN_THREAD"になります。

postback.title

クリックされたコールトゥーアクション(CTA)のタイトル

recipient.id

FacebookページのID

sender.user_ref

スタート、チャットプラグイン、固定メニュー項目をクリックするなど、メッセージを送信するアクションを実行した人の参照ID

timestamp

Webhook通知がサーバーに送信された日付のUnixタイムスタンプ

参考情報

このメッセージポストバックWebhooksガイドに記載されているコンセプトについてより理解するための追加の開発者ドキュメント。