Platform Messenger

Referensi Peristiwa Webhook messaging_optins

Peristiwa Webhook Keikutsertaan Menerima Pesan dipicu ketika seseorang memilih ikut serta menerima Pesan Marketing atau mengetuk plugin Kirim ke Messenger.

Saat menggunakan plugin Kirim ke Messenger, parameter optin.ref diatur dengan kolom data-ref di plugin "Kirim ke Messenger". Kolom ini dapat digunakan oleh developer untuk mengaitkan peristiwa klik pada plugin dengan panggilan balik.

Notifikasi Webhook Keikutsertaan Menerima Pesan

Aplikasi Anda akan menerima notifikasi webhook keikutsertaan ketika terjadi hal berikut:

  • Seseorang ikut serta
  • Seseorang ikut serta kembali dengan mengeklik tombol Lanjutkan Pesan yang ditampilkan sebelum token pesan notifikasi kedaluwarsa
  • Seseorang mengubah status keikutsertaan mereka, menghentikan notifikasi, atau melanjutkan notifikasi
{
  "sender": {
    "id": "PSID",
  },
  "recipient": {
    "id": "PAGE-ID",
  },
  "timestamp": "TIMESTAMP",
  "optin": {
    "type": "notification_messages", 
    "payload": "ADDITIONAL-INFORMATION",
    "notification_messages_token": "NOTIFICATION-MESSAGES-TOKEN", 
    "notification_messages_frequency": "FREQUENCY",  
    "notification_messages_timezone": "TIMEZONE-ID",
    "token_expiry_timestamp": "TIMESTAMP",
    "user_token_status": "TOKEN-STATUS",  
    "notification_messages_status": "NOTIFICATION-STATUS",
    "title": "TITLE" 
    }
}

optin

PropertiDeskripsi

payload

string

Informasi tambahan yang ingin Anda sertakan dalam notifikasi Webhooks

title

string

Judul yang ditampilkan di template

notification_messages_token

string

Token yang mewakili peserta, dengan frekuensi pesan dan topik tertentu, yang digunakan untuk mengirim Pesan Marketing

notification_messages_frequency

enum { DAILY, WEEKLY, MONTHLY }

Nilainya dapat berupa salah satu dari berikut ini:

  • HARIAN - kirim 1 notifikasi per periode 24 jam selama 6 bulan dari tanggal keikutsertaan
  • MINGGUAN - kirim 1 notifikasi per minggu selama 9 bulan dari tanggal keikutsertaan
  • BULANAN - kirim 1 notifikasi per bulan selama 12 bulan dari tanggal keikutsertaan

(Dihapus di API v16)

notification_messages_timezone

string

Zona waktu orang yang menerima pesan

notification_messages_status

enum { STOP NOTIFICATIONS, RESUME NOTIFICATIONS } 		Kolom ini hanya ada saat pengguna berhenti atau melanjutkan Pesan Marketing.

Nilainya dapat berupa salah satu dari berikut ini:

  • HENTIKAN NOTIFIKASI - Pengguna telah mengeklik "Hentikan pesan ini"
  • LANJUTKAN NOTIFIKASI - Pengguna telah mengeklik "Lanjutkan pesan ini"

token_expiry_timestamp

unix timestamp

Tanggal kedaluwarsa token pesan notifikasi

type

string

Nilai harus berupa notification_messages

user_token_status

enum { REFRESHED, NOT_REFRESHED }

Nilainya dapat berupa salah satu dari berikut ini:

  • REFRESHED - Nilai ini diatur saat pengguna memilih untuk kembali ikut serta dalam menerima Pesan Marketing setelah token kedaluwarsa
  • NOT_REFRESHED - Nilai default dan diatur ketika pengguna tidak kembali ikut serta dalam menerima Pesan Marketing setelah token kedaluwarsa