`messaging_referrals` Webhooks 事件参考文档

当用户与智能助手处于对话中并且用户通过以下方式进入对话时，将发生 messaging_referrals 回调：

如要追踪新对话中的推荐，请参阅回传事件。

如要开始接收这些事件，您需要在应用的 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 日）

若为图谱 API v7.0 及以上版本，聊天插件的 messaging_referrals Webhooks 事件将不会返回 sender.id 字段，而是返回新的 sender.user_ref 字段。此变更将自 2020 年 11 月 2 日起对所有旧版图谱 API 生效。

新的推荐 Webhooks 事件（适用于图谱 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>"
  }
}

旧的推荐 Webhooks 事件（适用于图谱 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 事件的用户 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`	对象	此数据包含用户用于发起对话的 CTM 广告的相关信息。

`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 Webhooks 事件参考文档

目录

示例