Plugin Obrolan

Pada tanggal 9 Mei 2024, Anda tidak akan lagi dapat mengakses fungsi Plugin Obrolan. Begitu segera, Plugin Obrolan dalam mode tamu tidak lagi tersedia. Fitur lain seperti tautan m.me akan tetap tersedia untuk Anda gunakan.

Dokumen ini menunjukkan kepada Anda cara menambahkan Plugin Obrolan secara terprogram ke pengalaman Messenger Anda di situs web.

Jika Anda ingin menggunakan Meta Business Suite untuk menambahkan Plugin Obrolan ke halaman web Anda (direkomendasikan), kunjungi Pusat Bantuan Bisnis Meta untuk informasi selengkapnya.

Cara Kerjanya

Saat Anda menginstal Facebook SDK untuk JavaScript di halaman web Anda, Plugin Obrolan akan ditampilkan di halaman web. Secara default, dialog salam akan ditampilkan di desktop dan perangkat seluler. Seseorang juga dapat mengeklik tombol tutup untuk meminimalkan dialog. Anda dapat menyesuaikan salam, tampilan, seperti warna, dan pengalaman berkirim pesan, seperti menu dan balasan cepat, dari plugin. Status dialog di-cache, dimaksimalkan atau diminimalkan, dan berlanjut dari sesi ke sesi.

Login

Jika orang tersebut login ke Facebook, plugin akan menampilkan tombol "Lanjutkan sebagai [NAME]" dan "Lanjutkan sebagai Tamu". Jika orang tersebut tidak login ke Facebook, plugin akan menampilkan tombol "Masuk ke Messenger" dan "Lanjutkan sebagai Tamu".

Notifikasi Webhook

Ketika seseorang mengeklik plugin untuk memulai atau melanjutkan obrolan dengan bisnis Anda, notifikasi Webhooks akan dikirim ke server Anda yang berisi:

  • Informasi tentang orang tersebut, seperti ID lingkup Halaman (PSID) atau ID referensi Pengguna
  • Identifikasikan sumber pesan sebagai Plugin Obrolan
  • Informasi rujukan yang disertakan dalam notifikasi

Jika Anda telah menerapkan Layar Selamat Datang di plugin dan orang tersebut mengeklik tombol Mulai untuk memulai percakapan dengan bisnis Anda, notifikasi Webhooks messaging_postbacks akan dikirim ke server Anda. Bisnis Anda kemudian dapat menggunakan ID referensi pengguna untuk mengirim pesan kepada orang tersebut dalam periode berkirim pesan standar 24 jam.

Percakapan yang Ada

Jika orang tersebut memiliki percakapan yang sudah ada dengan bisnis Anda, riwayat obrolan akan dimuat secara otomatis di plugin. Ketika orang tersebut melanjutkan percakapan, baik mengirim pesan, mengeklik tombol, atau mengambil tindakan lain yang telah Anda terapkan dalam percakapan, notifikasi Webhooks messaging akan dikirim ke server Anda atau notifikasi Webhooks messaging_referral jika Anda ingin menyertakan informasi rujukan. Bisnis Anda kemudian dapat menggunakan PSID untuk mengirim pesan kepada orang tersebut dalam periode berkirim pesan standar 24 jam.

Jenis Pesan yang Didukung oleh Plugin Obrolan

  • Audio, Video, Gambar, dan GIF
  • Tombol Telepon
  • Menu Persisten
  • Tombol Postback
  • Tindakan Pengirim
  • Pesan Teks
  • Balasan Cepat Teks
  • Tombol URL
  • Balasan Cepat Email Pengguna
  • Balasan Cepat Nomor Telepon Pengguna

Plugin tidak mendukung:

  • Tombol Beli
  • Tombol Main Game
  • Template Daftar, Media, atau Graf Terbuka
  • Balasan Cepat Lokasi
  • Tombol Login
  • Tombol Keluar
  • Browser dalam-aplikasi Messenger
  • Tombol Bagikan

Sebelum Memulai

Panduan ini berasumsi bahwa Anda telah membaca Ringkasan Platform Messenger dan menerapkan komponen yang dibutuhkan untuk mengirim dan menerima pesan serta notifikasi.

Anda memerlukan:

  • Izin pages_messaging
  • Token akses Halaman yang diminta dari orang yang dapat melakukan tugas MODERATE di Halaman Facebook
  • Aplikasi yang tertaut ke Halaman Facebook Anda berlangganan kolom Webhooks messaging, messaging_postbacks, dan messaging_referrals
  • Domain untuk situs web Anda ditambahkan ke daftar diizinkan menggunakan API Profil Messenger atau Meta Business Suite

Ketentuan Fitur Meta Business berlaku sehubungan dengan penggunaan Anda atas Plugin Obrolan.

Batasan

  • Situs web Anda harus aktif atau masuk daftar diizinkan sebelum Plugin Obrolan dapat berhasil diterapkan
  • Jika Halaman Anda bisnis Anda memiliki pembatasan usia atau negara yang diatur di pengaturan Halaman, Plugin Obrolan tidak akan di-render kepada pengguna yang tidak login ke akun Facebook mereka saat mengunjungi situs web Anda.
  • Dialog salam tidak di-cache untuk browser Safari 12+ dan Firefox

Menambahkan Plugin Obrolan

Langkah 1. Tambahkan SDK

Tambahkan Facebook SDK untuk JavaScript ke setiap halaman situs web Anda tempat Anda ingin me-render plugin.

<!-- Messenger Chat Plugin Code --> <div id="fb-root"></div> <div id="fb-customer-chat" class="fb-customerchat"></div> <script> var chatbox = document.getElementById('fb-customer-chat'); chatbox.setAttribute("page_id", "PAGE-ID"); chatbox.setAttribute("attribution", "biz_inbox"); </script> <script> window.fbAsyncInit = function() { FB.init({ xfbml : true, version : 'API-VERSION' }); }; (function(d, s, id) { var js, fjs = d.getElementsByTagName(s)[0]; if (d.getElementById(id)) return; js = d.createElement(s); js.id = id; js.src = 'https://connect.facebook.net/en_US/sdk/xfbml.customerchat.js'; fjs.parentNode.insertBefore(js, fjs); }(document, 'script', 'facebook-jssdk')); </script> 

Langkah 2. Sesuaikan Plugin

Menggunakan API

Kirim permintaan POST ke endpoint /PAGE-ID/chat_plugin untuk menyesuaikan salam, warna, ikon, dan lainnya, untuk plugin Anda.

Contoh Permintaan

Diformat agar mudah dibaca.
curl -i -X POST "https://graph.facebook.com/v21.0/PAGE-ID/chat_plugin
    ?welcome_screen_greeting:YOUR-WELCOME-TEXT
    &theme_color:553399
    &entry_point_icon:MESSENGER-ICON
    &entry_point_label:CHAT
    &access_token=PAGE-ACCESS-TOKEN"

Kunjungi Referensi Plugin Obrolan untuk informasi selengkapnya tentang kolom yang digunakan untuk menyesuaikan plugin Anda.

Gunakan atribut HTML

Kami merekomendasikan Anda hanya menggunakan metode ini untuk penyesuaian yang tidak tersedia melalui fitur pengaturan Halaman atau API.

AtributDeskripsi

theme_color

Opsional. Warna yang akan digunakan sebagai tema untuk plugin, termasuk warna latar belakang ikon Plugin Obrolan dan warna latar belakang pesan yang dikirimkan oleh pengguna. Mendukung kode warna heksadesimal yang diawali dengan tanda nomor (mis. #0084FF), kecuali putih. Kami sangat merekomendasikan Anda untuk memilih warna yang memiliki kontras tinggi terhadap warna putih.

logged_in_greeting

Opsional. Teks salam yang akan ditampilkan jika pengguna saat ini sudah login ke Facebook. Maksimal 80 karakter.

logged_out_greeting

Opsional. Teks salam yang akan ditampilkan jika pengguna saat ini belum login ke Facebook. Maksimal 80 karakter.

greeting_dialog_display

Opsional. Mengatur tampilan plugin dan dialog salam. Nilai-nilai berikut didukung:


  • show: Dialog salam ditampilkan dan tetap terbuka di desktop dan seluler setelah beberapa detik sesuai yang ditetapkan dengan atribut greeting_dialog_delay.
  • fade: Dialog salam ditampilkan sekilas setelah beberapa detik sesuai yang ditetapkan dengan atribut greeting_dialog_delay, lalu menghilang perlahan dan disembunyikan di desktop.
  • hide: Dialog salam disembunyikan hingga pengguna mengeklik plugin di desktop dan seluler. Teks salam akan ditampilkan di samping ikon.
  • hide: Dialog salam disembunyikan hingga pengguna mengeklik plugin di desktop dan seluler. Teks salam tidak akan ditampilkan.

Secara default, plugin diatur ke show pada desktop dan perangkat seluler. Lihat bagian Perilaku Penyimpanan Cache di bawah ini untuk selengkapnya..

greeting_dialog_delay

Opsional. Mengatur jumlah durasi penundaan dalam hitungan detik untuk tampilnya dialog salam setelah plugin dimuat. Ini dapat digunakan untuk menyesuaikan waktu tampilnya dialog salam. Jika greeting_dialog_delay diatur tetapi greeting_dialog_display tidak, kami masih akan menunda dialog salam di desktop. Akan tetapi, kami tidak akan melakukan penundaan di perangkat seluler.

ref

Opsional. Anda dapat meneruskan parameter ref opsional jika Anda ingin menyertakan konteks tambahan agar diteruskan kembali pada peristiwa webhook. Ini dapat digunakan untuk berbagai macam tujuan, seperti melacak di halaman mana pengguna memulai percakapan, mengarahkan pengguna ke konten atau fitur khusus yang tersedia di dalam bot, atau mengikat pengguna Messenger dengan sesi atau akun di situs web.

Notifikasi Webhooks

Ketika seseorang mengirim pesan ke bisnis Anda, notifikasi Webhooks akan dikirim ke server Anda.

Percakapan yang Ada

Notifikasi Webhooks messaging dikirim ketika seseorang mengirim pesan ke percakapan yang sudah ada dengan bisnis Anda. Notifikasi akan menyertakan ID lingkup Halaman seseorang dan parameter source objek tags diatur ke customer_chat_plugin.

Notifikasi Berkirim Pesan

{
    "object": "page",
    "entry": [
        {
            "id": "PAGE-ID",
            "time": 1559598624359,
            "messaging": [
                {
                    "sender": {
                        "id": "PSID"
                    },
                    "recipient": {
                        "id": "PAGE-ID"
                    },
                    "timestamp": 1559598623749,
                    "message": {
                        "tags": {
                            "source": "customer_chat_plugin"
                        },
                        "mid": "nhEqs_THGoYyAhpK93uNCrIfLZD...",
                        "text": "hello, from customer chat!"
                    }
                }
            ]
        }
    ]
}

Notifikasi Rujukan Berkirim Pesan

Jika Anda mengatur atribut ref untuk Plugin Obrolan Anda, notifikasi Webhooks messaging_referrals akan dikirim ke server Anda.

{
    "object": "page",
    "entry": [
        {
            "id": "PAGE-ID",
            "time": 1559598385735,
            "messaging": [
                {
                    "recipient": {
                        "id": "PAGE-ID"
                    },
                    "timestamp": 1559598385735,
                    "sender": {
                        "user_ref":"USER-REFERENCE-ID"
                    },
                    "referral": {
                        "ref": "REF-PARAMETER-INFORMATION",
                        "source": "CUSTOMER_CHAT_PLUGIN",
                        "type": "OPEN_THREAD",
                        "referer_uri": "REFERRAL-URI"
                    }
                }
            ]
        }
    ]
}

Percakapan Baru

Notifikasi Webhooks messaging_postbacks dikirim ketika seseorang memulai percakapan dengan mengeklik tombol Mulai di Layar Selamat Datang di plugin.

Notifikasi Postback Berkirim Pesan

{
    "object": "page",
    "entry": [
        {
            "id": "PAGE-ID",
            "time": 1559598624359,
            "messaging": [
                {
                    "sender": {
                        "user_ref": "USER-REFERENCE-ID"
                    },
                    "recipient": {
                        "id": "PAGE-ID"
                    },
                    "timestamp": 1559598623749,
                    "postback":{
                        "title": "TITLE-FOR-THE-CTA",  
                        "payload": "PAYLOAD-DEFINED-BY-CTA",
                        "referral": {
                            "ref": "ADDITIONAL-INFORMATION",
                            "source": "CUSTOMER_CHAT_PLUGIN",
                            "type": "OPEN_THREAD",
                    }
                }
            ]
        }
    ]
}

Permintaan Ikut Serta Pesan Marketing

Kunjungi Panduan Pesan Marketing kami untuk cara membuat permintaan ikut serta pesan marketing.

Batasan

Hanya topik Pembaruan & Promosi yang didukung untuk Pesan Marketing untuk Plugin Obrolan.

Notifikasi Ikut Serta Berkirim Pesan

Notifikasi Webhooks messaging_optins akan dikirim ke server Anda ketika seseorang memilih ikut serta untuk menerima Pesan Marketing dari bisnis Anda.

"object": "page",
    "entry": [
        {
            "id": "PAGE-ID",
            "time": TIMESTAMP,
            "messaging": [
                {
                    "recipient": {
                        "id": "PAGE-ID"
                    },
                    "timestamp": TIMESTAMP,
                    "optin": {
                        "type": "notification_messages",
                        "payload": "empty_payload",
                        "notification_messages_token": "NOTIFICATION-MESSAGE-TOKEN",
                        "notification_messages_frequency": "MESSAGE-FREQUENCY",
                        "topic": "NOTIFICATION-MESSAGE-TOPIC",
                        "token_expiry_timestamp": EXPIRATION-DATE-TIMESTAMP,
                        "ref": "ADDITIONAL-INFORMATION",
                        "user_token_status": "NOT_REFRESHED",
                        "notification_messages_status": "RESUME_NOTIFICATIONS"
                    }
                }
            ]
        }
    ]
}

Anda dapat mengatur nilai notification_messages_token ke nilai ID dalam objek recipient untuk mengirim Pesan Marketing kepada seseorang.

Kiat Pemecahan Masalah

  • Menolak menampilkan...
    • Pastikan domain Anda telah dimasukkan daftar putih
    • Pastikan headerReferrer-Policy diatur sehingga URL perujuk terkirim
  • Plugin Obrolan tidak me-render di Firefox
    • Hapus Add-On Kontainer Facebook di Firefox.
    • Nonaktifkan pemblokiran konten (klik perisai abu-abu pada bilah pencarian) untuk membuat plugin di-render.

Lihat Juga