Platform Messenger

Referensi Send API

Send API adalah API utama yang digunakan untuk mengirimkan pesan kepada pengguna, termasuk teks, lampiran, template, tindakan pengirim, dan lainnya.

Membuat

Buat dan kirim pesan kepada pelanggan Anda atau orang-orang yang tertarik dengan halaman Facebook Anda.

Sebelum Memulai

Anda akan memerlukan:

  • Token akses Halaman yang diminta oleh seseorang yang dapat melakukan tugas MESSAGE pada Halaman tersebut
  • Izin pages_messaging
  • Penerima pesan harus sudah mengirimkan pesan ke Halaman Anda dalam kurun waktu 24 jam terakhir atau setuju untuk menerima pesan dari Halaman Anda di luar interval pengiriman pesan standar 24 jam

Batasan

  • Tanda pesan tidak dapat digunakan untuk mengirimkan 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 mengirimkan pesan kepada seseorang, kirimkan permintaan POST kepada endpoint /PAGE-ID/messsages dengan messaging_type dan parameter recipient yang sudah ditetapkan, serta konten pesan.

Diformat untuk keterbacaan.

Contoh berikut ini adalah respons dari pesan seseorang yang isi pesannya dikirimkan dari Halaman Anda hanya berbentuk teks.

curl -i -X POST "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/messages
    ?recipient={'id':'PSID'}
    &messaging_type=RESPONSE
    &message={'text':'hello,world'}
    &access_token=PAGE-ACCESS-TOKEN

Apabila berhasil, aplikasi Anda akan menerima respons JSON berikut ini:

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

Parameter

ParameterDeskripsi

message

objek

Jenis pesan yang dikirimkan Halaman Anda. Berupa text atau attachement harus ditetapkan ketika menggunakan parameter.

  • Objek attachment – Mempratinjau URL. Digunakan untuk mengirimkan 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 – String data tambahan yang ingin Anda teruskan di message_echo webhook. Harus kurang dari 1.000 karakter

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

messaging_type

enum

Wajib

Jenis pesan yang dikirimkan

notification_type

enum

Jenis notifikasi otomatis yang akan diterima seseorang

  • NO_PUSH – Tanpa notifikasi
  • REGULAR (default) – Suara atau getar ketika pesan diterima oleh seseorang
  • SILENT_PUSH – Hanya notifikasi di layar

recipient

objek

Wajib

Orang yang akan menerima pesan yang dikirimkan Halaman Anda

  • id – ID cakupan Halaman bagi seseorang yang digunakan untuk mengirimkan pesan sebagai tanggapan atas pesan yang diterima oleh Halaman Anda dalam kurun waktu 24 jam terakhir atau bagi seseorang yang sudah setuju untuk menerima pesan dari Halaman Anda di luar interval pengiriman pesan standar 24 jam
  • user_ref – Referensi bagi seseorang yang digunakan untuk mengirimkan pesan sebagai tanggapan atas Kotak Centang atau Plugin Obrolan Pelanggan
  • comment_id – ID untuk komentar yang digunakan untuk mengirimkan pesan berbentuk Balasan Pribadi sebagai tanggapan atas Komentar pengunjung pada Postingan Halaman Anda
  • post_id – ID untuk Postingan Halaman yang digunakan untuk mengirimkan pesan berbentuk Balasan Pribadi sebagai tanggapan atas Postingan pengunjung pada Halaman Anda

sender_action

enum

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

  • typing_on – Tampilkan gelembung ketik ketika Halaman mempersiapkan respons
  • typing_off – Jangan tampilkan gelembung ketik
  • mark_seen – Tampilkan ikon dilihat untuk pesan yang sudah dilihat oleh Halaman

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

tag

enum

Tanda yang memungkinkan Halaman Anda untuk mengirimkan pesan ke seseorang yang berada di luar interval pengiriman pesan standar 24 jam.

  • ACCOUNT_UPDATE – Memberi tanda pada pesan yang Anda kirimkan kepada pelanggan sebagai pembaruan tidak berulang ke akun atau aplikasi mereka. Tampilkan penggunaan yang diizinkan.

    Tidak tersedia untuk Messaging API Instagram.

  • CONFIRMED_EVENT_UPDATE – Memberi tanda pada pesan yang Anda kirimkan kepada pelanggan sebagai pengingat mengenai acara yang akan datang atau pembaruan atas acara yang sedang berlangsung yang untuknya pelanggan terdaftar. Tampilkan penggunaan yang diizinkan.

    Tidak tersedia untuk Messaging API Instagram.

  • CUSTOMER_FEEDBACK – Memberi tanda pada pesan yang Anda kirimkan kepada pelanggan sebagai Survei Masukan Pelanggan . Pesan masukan pelanggan harus dikirimkan dalam kurun waktu 7 hari dari pesan terakhir pelanggan. Tampilkan penggunaan yang diizinkan.

    Tidak tersedia untuk Messaging API Instagram.

  • HUMAN_AGENT – Diperlukan untuk Messaging API Instagram. Apabila tanda ini ditambahkan ke pesan yang dikirimkan ke seseorang, tanda ini memungkinkan agen manusia untuk merespons pesan orang tersebut. Pesan dapat dikirimkan dalam kurun waktu 7 hari dari pesan seseorang. Dukungan agen manusia digunakan untuk masalah yang tidak dapat diselesaikan dalam interval pengiriman pesan standar. Tampilkan penggunaan yang diizinkan.
    • Aplikasi nantinya perlu meminta izin Human Agent melalui dasbor Aplikasi Developer. Buka Dasbor aplikasi -> Tinjauan aplikasi -> Izin & Fitur -> Agen Manusia. Aplikasi yang sebelumnya sudah disetujui untuk akses beta ke izin Agen Manusia tidak perlu meminta akses lagi.

    Izin Human Agent tidak tersedia di akses standar atau mode pengembangan. Anda nantinya perlu menyelesaikan proses tinjauan aplikasi sebelum dapat memanfaatkan tanda agen manusia. Selama pengajuan tinjauan aplikasi, harap sediakan instruksi yang jelas dan demonstrasi tentang cara Anda ingin memanfaatkan tanda agen manusia dalam pengalaman Anda.

  • POST_PURCHASE_UPDATE – Memberi tanda pada pesan yang Anda kirimkan kepada pelanggan sebagai pembaruan atas pembelian terakhir yang dibuat oleh pelanggan. Tampilkan penggunaan yang diizinkan.

    Tidak tersedia untuk Messaging API Instagram.

Penggunaan Tanda Pesan

Tabel berikut ini mencantumkan jenis pengiriman pesan untuk masing-masing tanda pesan.

Tanda PesanPenggunaan

ACCOUNT_UPDATE

Penggunaan yang Diizinkan

  • Notifikasi untuk perubahan dalam status pada aplikasi, misalnya untuk kartu kredit atau lamaran kerja
  • Notifikasi untuk aktivitas yang mencurigakan, misalnya peringatan penipuan

Penggunaan yang Tidak Diizinkan (tidak menyeluruh)

  • Konten promosi, termasuk namun tidak terbatas pada konten Berulang mengenai penawaran, promosi, kupon, dan diskon (misalnya, laporan sudah siap, tagihan harus dibayar, iklan pekerjaan baru)
  • Arahan ke survei, polling, atau tinjauan apa pun yang tidak berkaitan dengan interaksi sebelumnya di Messenger

Tidak tersedia untuk Messaging API Instagram.

CONFIRMED_EVENT_UPDATE

Penggunaan yang Diizinkan

  • Pengingat untuk kelas, janji temu, atau acara akan datang yang telah dijadwalkan pengguna
  • Konfirmasi untuk kehadiran atau reservasi pengguna ke janji temu atau acara yang sudah diterima
  • Notifikasi untuk perjalanan terjadwal atau transportasi pengguna, misalnya waktu tiba, pembatalan, keterlambatan bagasi, atau perubahan status perjalanan lainnya

Penggunaan yang Tidak Diizinkan (tidak menyeluruh)

  • Konten promosi, termasuk namun tidak terbatas pada penawaran, promosi, kupon, dan diskon
  • Konten mengenai acara yang untuknya pengguna tidak mendaftar (misalnya, pengingat untuk membeli tiket acara, melakukan cross-selling acara lainnya, jadwal tur, dsb.)
  • Pesan terkait acara yang sudah lewat
  • Arahan ke survei, polling, atau tinjauan apa pun yang tidak berkaitan dengan interaksi sebelumnya di Messenger

Tidak tersedia untuk Messaging API Instagram.

CUSTOMER_FEEDBACK

Penggunaan yang Diizinkan

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

Penggunaan yang Tidak Diizinkan (tidak menyeluruh)

  • Tanda hanya dapat digunakan bersama Template Masukan Pelanggan. Penggunaan dalam bentuk lainnya dilarang dan akan gagal.

Tidak tersedia untuk Messaging API Instagram.

HUMAN_AGENT

Penggunaan yang Diizinkan

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

Penggunaan yang Tidak Diizinkan (tidak menyeluruh)

  • Pesan otomatis
  • Konten yang tidak berkaitan dengan pertanyaan pengguna

Diperlukan untuk Messaging API Instagram.

POST_PURCHASE_UPDATE

Penggunaan yang Diizinkan

  • Konfirmasi untuk transaksi, seperti invoice atau tanda terima
  • Status terbaru untuk pengiriman, seperti produk yang sedang dalam transit, pengiriman, pengantaran, atau tertunda
  • Status terbaru yang mengharuskan pengguna untuk mengambil tindakan atas pesanan yang sudah dibuat oleh pengguna, seperti kartu kredit yang ditolak, pemesanan kembali produk, atau pembaruan pesanan lainnya yang memerlukan tindakan pengguna

Penggunaan yang Tidak Diizinkan (tidak menyeluruh)

  • Konten promosi, termasuk namun tidak terbatas pada penawaran, promosi, kupon, dan diskon
  • Pesan yang melakukan cross-selling atau menjual produk maupun layanan upsell
  • Arahan ke survei, polling, atau tinjauan apa pun yang tidak berkaitan dengan interaksi sebelumnya di Messenger

Tidak tersedia untuk Messaging API Instagram.

Membaca

Anda tidak dapat melakukan operasi ini di endpoint ini.

Untuk mendapatkan informasi mengenai percakapan yang melibatkan 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