Platform Messenger

Referensi Send API

Send API adalah API utama yang digunakan untuk mengirim pesan ke pengguna, termasuk teks, lampiran, template, tindakan pengirim, dan banyak lagi.

Membuat

Buat dan kirim pesan ke pelanggan Anda atau orang-orang yang tertarik dengan Halaman Facebook Anda.

Sebelum Memulai

Anda akan memerlukan:

  • Token akses Halaman yang diminta oleh orang yang dapat melakukan tugas MESSAGE di Halaman
  • Izin pages_messaging
  • Penerima pesan harus telah mengirim pesan ke Halaman Anda dalam 24 jam terakhir atau setuju untuk menerima pesan dari Halaman Anda di luar periode berkirim pesan standar 24 jam

Batasan

  • Tanda pesan tidak dapat digunakan untuk mengirim konten promosi

Perhatikan bahwa API Kirim tidak menyertakan recipient_id dalam tanggapan untuk pesan yang dikirim menggunakan recipient.user_ref atau recipient.phone_number untuk mengidentifikasi penerima pesan.

Contoh Permintaan

Untuk mengirim pesan ke seseorang, kirim permintaan POST ke endpoint /PAGE-ID/messsages dengan parameter messaging_type dan recipient diatur, bersama konten pesan.

Diformat agar mudah dibaca.

Contoh berikut adalah tanggapan terhadap pesan seseorang ketika pesan yang dikirim Halaman Anda hanya berupa teks.

curl -X POST "https://graph.facebook.com/v21.0/{PAGE_ID}/messages" \
      -d "recipient={'id':'{PSID}'}" \
      -d "messaging_type=RESPONSE" \
      -d "message={'text':'hello, world'}" \
      -d "access_token={PAGE_ACCESS_TOKEN}"

Setelah berhasil, aplikasi akan menerima tanggapan JSON berikut:

{
  "recipient_id": "PAGE-SCOPED-ID",
  "message_id": "AG5Hz2U..."
}

Parameter

ParameterDeskripsi

message

objek

Jenis pesan yang dikirimkan Halaman Anda. Nilai text atau attachement harus diatur saat menggunakan parameter ini.

  • Objek attachment – Menampilkan pratinjau URL. Digunakan untuk mengirim pesan dengan media atau Pesan Terstruktur. text atau attachment harus diatur.

    • type – Jenis lampiran. Dapat berupa audio, file, image, template, atau video. Ukuran file maksimum adalah 25 MB
    • payload – Objek yang berisi konten template atau konten file

  • metadata – Data tambahan yang ingin Anda teruskan di Webhooks message_echo. Harus kurang dari 1.000 karakter

  • quick_replies – Array balasan cepat yang akan dikirim dalam pesan
  • text – Pesan yang hanya berisi teks. Harus UTF-8 dan kurang dari 2.000 karakter.

messaging_type

enum

Diwajibkan

Jenis pesan yang dikirimkan

  • RESPONSE – Pesan adalah tanggapan terhadap pesan yang diterima. Ini termasuk pesan promosi dan non-promosi yang dikirim dalam periode berkirim pesan standar 24 jam. Contoh: gunakan tanda ini untuk menanggapi jika seseorang meminta konfirmasi reservasi atau pembaruan status.
  • UPDATE – Pesan dikirim secara proaktif dan bukan tanggapan pesan yang diterima. Ini termasuk pesan promosi dan nonpromosi yang dikirim dalam periode berkirim pesan standar 24 jam.
  • MESSAGE_TAG – Pesan tidak bersifat promosi dan sedang dikirim di luar periode berkirim pesan standar 24 jam dengan tanda pesan. Pesan harus sesuai dengan kasus penggunaan yang diizinkan untuk tanda.

notification_type

enum

Jenis notifikasi otomatis yang akan diterima seseorang

  • NO_PUSH – Tidak ada notifikasi
  • REGULAR (default) – Suara atau getaran saat pesan diterima oleh seseorang
  • SILENT_PUSH – Hanya notifikasi di layar

recipient

objek

Diwajibkan

Orang yang akan menerima pesan yang dikirimkan oleh Halaman Anda

  • id – ID lingkup-Halaman untuk orang yang digunakan untuk mengirim pesan sebagai tanggapan atas pesan yang diterima oleh Halaman Anda dalam 24 jam terakhir atau untuk orang yang telah setuju untuk menerima pesan dari Halaman Anda di luar periode berkirim pesan standar 24 jam
  • user_ref – Referensi untuk orang yang digunakan untuk mengirim pesan sebagai tanggapan atas Kotak Centang atau Plugin Obrolan Pelanggan
  • comment_id – ID untuk komentar yang digunakan untuk mengirim pesan sebagai Balasan Pribadi dalam menanggapi Komentar pengunjung di Postingan Halaman Anda
  • post_id – ID untuk Postingan Halaman yang digunakan untuk mengirim pesan sebagai Balasan Pribadi dalam menanggapi Postingan pengunjung di Halaman Anda

sender_action

enum

Ikon tindakan yang ditampilkan di jendela pesan menunjukkan tindakan yang diambil oleh Halaman pada pesan yang diterima Halaman dari seseorang.

  • typing_on – Menampilkan gelembung obrolan ketika Halaman sedang menyiapkan tanggapan
  • typing_off – Tidak menampilkan gelembung obrolan
  • mark_seen – Menampilkan ikon sudah dilihat untuk pesan yang telah dilihat oleh Halaman

Hanya dapat dikirim dengan parameter recipient. Tidak dapat dikirim dengan parameter message, tetapi harus dikirim sebagai permintaan terpisah.

tag

enum

Tanda yang memungkinkan Halaman Anda untuk mengirim pesan kepada seseorang di luar periode berkirim pesan standar 24 jam.

  • ACCOUNT_UPDATE–Menandai pesan yang Anda kirim ke pelanggan sebagai pembaruan tidak berulang ke aplikasi atau akun mereka. Lihat penggunaan yang diizinkan.

    Tidak tersedia untuk API Messaging Instagram.

  • CONFIRMED_EVENT_UPDATE – Menandai pesan yang Anda kirim ke pelanggan sebagai pengingat untuk acara mendatang atau pembaruan untuk acara yang sedang berlangsung yang diikuti pelanggan. Lihat penggunaan yang diizinkan.

    Tidak tersedia untuk API Messaging Instagram.

  • CUSTOMER_FEEDBACK – Menandai pesan yang Anda kirim ke pelanggan sebagai Survei Masukan Pelanggan. Survei masukan pelanggan harus dikirim dalam 7 hari sejak pesan terakhir pelanggan. Lihat penggunaan yang diizinkan.

    Tidak tersedia untuk API Messaging Instagram.

  • HUMAN_AGENT – Wajib untuk API Messaging Instagram. Ketika tanda ini ditambahkan ke pesan yang dikirimkan kepada seseorang, agen manusia dapat menanggapi pesan orang tersebut. Pesan dapat dikirim dalam waktu 7 hari dari diterimanya pesan pengguna. Dukungan agen manusia adalah untuk masalah yang tidak dapat diselesaikan dalam periode berkirim pesan standar. Lihat penggunaan yang diizinkan.
    • Aplikasi harus mengajukan izin Human Agent melalui dasbor Aplikasi Developer. Navigasi ke Dasbor Aplikasi --> Tinjauan Aplikasi --> Izin & Fitur --> Agen Manusia. Aplikasi yang sebelumnya disetujui untuk akses beta ke izin Agen Manusia tidak perlu mengajukan ulang permohonan akses.

    Izin Human Agent tidak tersedia dalam akses standar atau mode pengembangan. Anda perlu menyelesaikan proses tinjauan aplikasi sebelum Anda dapat memanfaatkan tanda agen manusia. Saat pengajuan tinjauan aplikasi, berikan instruksi dan demonstrasi yang jelas tentang bagaimana Anda ingin memanfaatkan tanda agen manusia dalam pengalaman Anda.

  • POST_PURCHASE_UPDATE – Menandai pesan yang Anda kirim kepada pelanggan sebagai info terkini untuk pembelian terbaru yang dilakukan oleh pelanggan. Lihat penggunaan yang diizinkan.

    Tidak tersedia untuk API Messaging Instagram.

Penggunaan Tanda Pesan

Tabel berikut berisi daftar jenis berkirim pesan untuk setiap tanda pesan.

Tanda PesanPenggunaan

ACCOUNT_UPDATE

Penggunaan Diizinkan

  • Notifikasi untuk perubahan status aplikasi, seperti untuk kartu kredit atau lamaran kerja
  • Notifikasi untuk aktivitas mencurigakan, seperti peringatan penipuan

Penggunaan yang Tidak Diizinkan (tidak lengkap)

  • Konten promosi, termasuk tetapi tidak terbatas pada promo, promosi, kupon, dan diskon Konten berulang (contohnya, laporan sudah siap, tagihan jatuh tempo, daftar lowongan kerja baru)
  • Anjuran untuk melakukan survei, polling, atau ulasan apa pun yang tidak terkait dengan interaksi sebelumnya di Messenger

Tidak tersedia untuk API Messaging Instagram.

CONFIRMED_EVENT_UPDATE

Penggunaan Diizinkan

  • Pengingat untuk kelas, janji temu, atau acara yang akan datang, yang telah dijadwalkan oleh pengguna
  • Konfirmasi reservasi atau kehadiran pengguna ke acara atau janji temu yang diterima
  • Notifikasi untuk transportasi atau jadwal perjalanan pengguna, seperti kedatangan, pembatalan, penundaan bagasi, atau perubahan status perjalanan lainnya

Penggunaan yang Tidak Diizinkan (tidak lengkap)

  • Konten promosi, termasuk tetapi tidak terbatas pada promo, penawaran, kupon, dan diskon
  • Konten yang terkait dengan acara yang belum didaftarkan pengguna (mis., pengingat untuk membeli tiket acara, cross-selling acara lain, jadwal tur, dll.)
  • Pesan terkait acara yang telah lalu
  • Anjuran untuk melakukan survei, polling, atau ulasan apa pun yang tidak terkait dengan interaksi sebelumnya di Messenger

Tidak tersedia untuk API Messaging Instagram.

CUSTOMER_FEEDBACK

Penggunaan Diizinkan

  • Survei untuk masukan dukungan pembelian
  • Survei untuk masukan acara
  • Ulasan produk

Penggunaan yang Tidak Diizinkan (tidak lengkap)

  • Tanda ini hanya dapat digunakan dengan Template Masukan Pelanggan. Penggunaan dalam bentuk lain dilarang dan akan gagal.

Tidak tersedia untuk API Messaging Instagram.

HUMAN_AGENT

Penggunaan Diizinkan

  • Dukungan agen manusia untuk masalah yang tidak dapat diselesaikan dalam periode pengiriman pesan standar 24 jam, seperti menyelesaikan masalah di luar jam kerja normal atau masalah yang membutuhkan lebih dari 24 jam untuk diselesaikan

Penggunaan yang Tidak Diizinkan (tidak lengkap)

  • Pesan otomatis
  • Konten yang tidak terkait dengan pertanyaan pengguna

Wajib untuk API Messaging Instagram.

POST_PURCHASE_UPDATE

Penggunaan Diizinkan

  • Konfirmasi transaksi, seperti faktur atau tanda terima
  • Info terkini status untuk pengiriman, seperti produk dalam transit, dikirim, tersampaikan, atau tertunda
  • Pembaruan status yang mengharuskan pengguna mengambil tindakan atas pesanan yang dilakukan pengguna, seperti penolakan kartu kredit, item pesanan di awal, atau pembaruan pesanan lainnya yang memerlukan tindakan pengguna

Penggunaan yang Tidak Diizinkan (tidak lengkap)

  • Konten promosi, termasuk tetapi tidak terbatas pada promo, promosi, kupon, dan diskon
  • Pesan yang cross-selling atau upsell produk atau layanan
  • Anjuran untuk melakukan survei, polling, atau ulasan apa pun yang tidak terkait dengan interaksi sebelumnya di Messenger

Tidak tersedia untuk API Messaging Instagram.

Membaca

Anda tidak dapat melakukan operasi ini di endpoint ini.

Untuk mendapatkan informasi tentang percakapan yang diikuti Halaman Anda, kunjungi Referensi Percakapan Halaman.

Memperbarui

Anda tidak dapat melakukan operasi ini di endpoint ini.

Menghapus

Anda tidak dapat melakukan operasi ini di endpoint ini.

Lihat Juga

Dukungan Developer