messaging_referrals Webhook 事件參考資料

這個回呼發生在用戶已經與 Bot 有對話串,然後用戶以下列方式回到對話串:

如需在新的對話串中追蹤轉介,請參閱回傳事件

若要開始接收這些事件,您需要在應用程式的 Webhook 設定中訂閱 messaging_referrals

內容

範例

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>
    }
  }
}

顧客洽談外掛程式

重大變更(2020 年 5 月 5 日)

洽談外掛程式的圖形 API 7.0 以上版本 messaging_referrals Webhook 事件不會傳回 sender.id 欄位。該事件會傳回新的 sender.user_ref 欄位。此變更將自 2020 年 11 月 2 日起對所有舊版的圖形 API 生效。

新版轉介 Webhook 事件(圖形 API 7.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 6.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

屬性型別說明

id

字串

觸發 Webhook 事件的用戶 PSID。

user_ref

字串

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

recipient

屬性型別說明

id

字串

您的粉絲專頁編號。

referral

屬性類型說明

source

字串

這個轉介的來源。支援的值:

  • ADS
  • SHORTLINK
  • CUSTOMER_CHAT_PLUGIN

type

字串

轉介類型。目前支援 OPEN_THREAD

ref

字串

可於轉介人中設定的 ref 選用屬性。僅支援英數字元以及 -、_ 和 =。

referer_uri

字串

在 Facebook 洽談外掛程式中傳送訊息的網站 URI。

is_guest_user

字串

用來指示用戶是否為 Facebook 洽談外掛程式之訪客用戶的旗幟

ads_context_data

物件

包含有關 CTM 廣告資訊的資料,用戶從其中開始對話串。

ads_context_data

PropertyTypeDescription

ad_title

String

Title of the Ad.

photo_url

String

[Optional] Url of the image from the Ad the user is interested.

video_url

String

[Optional] Thumbnail url of the the video from the ad.

post_id

String

ID of the post.

product_id

String

[Optional] Product ID from the Ad the user is interested.