`messaging_referrals` Webhook 事件參考資料

當用戶已與 BOT 展開對話串，而且用戶是從以下途徑前來此對話串時，系統便會發起此呼叫：

有關新對話串的追蹤轉介，請參閱回傳事件。

如要開始接收這類事件，您需要在應用程式的 Webhooks 設定中訂閱 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 日）

在 Graph API 7.0 版及以上版本，洽談附加程式的 messaging_referrals Webhook 事件將不會傳回 sender.id 欄位，而會傳回新的 sender.user_ref 欄位。此變更將於 2020 年 11 月 2 日起套用至所有較舊版本的 Graph API。

新的轉介 Webhook 事件（適用於 Graph API v7.0 及以上版本，並將於 2020 年 11 月 2 日起適用於所有版本的 Graph 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 事件（在 2020 年 11 月 2 日之前適用於 Graph API v6.0 及以下版本）

{
  "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 事件的用戶 user_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`	物件	這類資料中包含用戶用來發起對話串的 Messenger 發訊廣告之相關訊息。

`ads_context_data`

Property	Type	Description
`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.

messaging_referrals Webhook 事件參考資料

內容

範例