Referal Peristiwa Webhook `messaging_referrals`

Panggilan balik ini akan terjadi ketika pengguna sudah memiliki utas dengan bot, dan pengguna datang ke utas dari:

Mengikuti tautan m.me dengan parameter referal
Mengeklik Iklan Percakapan Messenger
Memulai atau melanjutkan percakapan dari plugin obrolan pelanggan.

Untuk referal pelacakan dalam utas baru, lihat Peristiwa Postback.

Untuk mulai menerima peristiwa ini, Anda perlu berlangganan messaging_referrals di pengaturan webhook untuk aplikasi Anda.

Contoh

Tautan 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",
  }
}

Referal Iklan

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

Plugin Obrolan Pelanggan

Perubahan Sela (5 Mei 2020)

Peristiwa webhook messaging_referrals Graph API v7.0+ dari plugin obrolan tidak akan mengembalikan kolom sender.id. Ini akan mengembalikan kolom sender.user_ref baru. Perubahan ini akan berlaku pada semua versi lama Graph API mulai 2 Nov 2020.

Peristiwa Webhook Referal Baru (Graph API v7.0 + dan semua versi Graph API mulai 2 Nov 2020)

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

Peristiwa Webhook Referal Lama (Graph API <= v6.0 - Tersedia sampai 2 Nov 2020)

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

Properti

`sender`

Properti	Jenis	Deskripsi
`id`	String	PSID pengguna yang memicu peristiwa webhook.
`user_ref`	String	User_ref dari pengguna yang memicu peristiwa webhook. Ini hanya tersedia untuk peristiwa webhook dari plugin obrolan.

`recipient`

Properti	Jenis	Deskripsi
`id`	String	ID Halaman Anda.

`referral`

Properti	Jenis	Deskripsi
`source`	String	Sumber referal. Nilai yang didukung: `ADS` `SHORTLINK` `CUSTOMER_CHAT_PLUGIN`
`type`	String	Jenis referal. Saat ini mendukung `OPEN_THREAD`.
`ref`	String	Atribut `ref` opsional yang diatur dalam perujuk. Yang didukung hanya karakter alfanumerik serta -, _, dan =.
`referer_uri`	String	URI situs tempat yang dikirimi pesan di plugin obrolan Facebook.
`is_guest_user`	String	Tanda bendera yang menunjukkan apakah pengguna adalah pengguna tamu dari Plugin Obrolan Facebook
`ads_context_data`	Objek	Data yang berisi informasi tentang iklan CTM, asal utas yang dimulai pengguna.

`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.

Referal Peristiwa Webhook messaging_referrals