messaging_referrals Webhookイベントのリファレンス

このコールバックは、ユーザーがすでにボットとのスレッドを保持しており、以下からそのスレッドに移動してきたときに行われます。

• リファーラルパラメーターが指定されたm.meリンクをたどって
• Messengerスレッドの広告をクリックして
• カスタマーチャットプラグインからスレッドを開始または再開します。

新しいスレッド内のリファーラルを追跡するには、ポストバックイベントを参照してください。

これらのイベントの受信を開始するには、アプリのWebhook設定でmessaging_referralsをサブスクリプション登録する必要があります。

内容

• 例

  • m.meリンク
  • 広告のリファーラル
  • カスタマーチャットプラグイン
• プロパティ

例

m.meリンク

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
    "ref": <REF_DATA_PASSED_IN_M.ME_PARAM>,
    "source": "SHORTLINK",
    "type": "OPEN_THREAD",
  }
}

広告のリファーラル

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "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>
    }
  }
}

カスタマーチャットプラグイン

新しいリファーラルWebhookイベント(グラフAPI v7.0以上 - 2020年11月2日以降はすべてのグラフAPIバージョンで使用可能)

{
  "sender":{
    "user_ref":"<USER_REF>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

古いリファーラルWebhookイベント(グラフAPI v6.0以下 - 2020年11月2日まで使用可能)

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

プロパティ

sender

recipient

referral

ads_context_data