Referensi persistent_menu

Menu persisten dapat diatur untuk bot Anda agar orang dapat menemukan dan lebih mudah mengakses fungsi Anda sepanjang percakapan.

Menu Persisten selalu tersedia untuk pengguna. Menu ini harus berisi tindakan utama yang dapat dilakukan pengguna kapan saja. Dengan memiliki menu persisten, Anda dengan mudah mengomunikasikan kemampuan dasar bot untuk pengguna yang pertama kali menggunakan maupun yang kembali menggunakan bot. Menu akan otomatis muncul di utas jika orang tersebut telah pergi selama jangka waktu tertentu dan kembali lagi. Pengaturan ini adalah bagian dari Referensi Messenger Profile API

Menu persisten juga dapat diatur dan diubah di tingkat pengguna. Untuk informasi selengkapnya mengenai hal ini, lihat menu tingkat pengguna.

Persyaratan

Untuk menggunakan menu persisten, Anda harus melakukan hal berikut:

  • Tetapkan peran 'Administrator' untuk halaman yang terkait dengan bot.

Format persistent_menu

Contoh Menu Persisten

{
    "persistent_menu": [
        {
            "locale": "default",
            "composer_input_disabled": false,
            "call_to_actions": [
                {
                    "type": "postback",
                    "title": "Talk to an agent",
                    "payload": "CARE_HELP"
                },
                {
                    "type": "postback",
                    "title": "Outfit suggestions",
                    "payload": "CURATION"
                },
                {
                    "type": "web_url",
                    "title": "Shop now",
                    "url": "https://www.originalcoastclothing.com/",
                    "webview_height_ratio": "full"
                }
            ]
        }
    ]
}

Properti

Properti Jenis Deskripsi

locale

String

Array objek yang menentukan menu persisten untuk locale yang berbeda. Menu dengan properti locale yang sesuai dengan locale orang tersebut akan ditampilkan.


Setidaknya satu objek di array persistent_menu harus menentukan "locale": "default". Ini adalah menu yang akan menjadi fallback jika tidak ada objek yang memiliki properti locale yang cocok dengan locale pengguna.


Lihat daftar locale yang didukung.

composer_input_disabled

Boolean

Menonaktifkan kolom tulis pesan Messenger jika diatur ke true. Ini berarti bot Anda hanya dapat berinteraksi melalui menu persisten, postback, tombol, dan tampilan web.


Default-nya adalah false.

disabled_surfaces

Array

Array nama antarmuka tempat menonaktifkan menu persisten. Saat ini hanya customer_chat_plugin yang didukung.

call_to_actions

Array<menu_item>

Array item menu utama untuk menu persisten. Maksimum 3 item diizinkan.


Wajib jika "composer_input_disabled": true.

Properti Jenis Deskripsi

type

String

Jenis item menu. Nilai yang didukung adalah:

title

String

Judul untuk ditampilkan pada item menu. Terbatas 30 karakter.

url

String

URL yang akan dibuka ketika tombol diketuk. Wajib jika jenisnya adalah web_url.

payload

String

Data yang akan dikirim kembali ke webhook Anda sebagai sebuah peristiwa messaging_postbacks. Wajib jika jenisnya adalah postback. Terbatas 1.000 karakter.

webview_height_ratio

String

Opsional. Tinggi tampilan web. Nilai yang valid meliputi compact, tall, full.

messenger_extensions

Boolean

Opsional. Harus true jika jenis itemnya adalah web_url dan SDK Ekstensi Messenger akan digunakan di tampilan web.

fallback_url

String

Opsional. URL yang akan dibuka di tampilan web untuk klien yang tidak mendukung SDK Ekstensi Messenger. Jika properti ini tidak ditentukan, url akan digunakan sebagai fallback. Properti ini hanya dapat ditentukan jika "messenger_extensions": true.

webview_share_button

String

Opsional. Atur ke hide untuk menonaktifkan berbagi di tampilan web (untuk info sensitif).

Menonaktifkan Menu Persisten

Mungkin ada kasus di mana lebih disukai untuk menonaktifkan menu persisten untuk bot Anda di Plugin Obrolan. Untuk menonaktifkannya, tambahkan "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"] saat menetapkan menu persisten Anda:

Contoh Muatan Messenger Profile API

{
  "persistent_menu":[
    {
      "locale":"default",
      "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"],
      "composer_input_disabled": false,      
      "call_to_actions":[
        {
          "title":"My Account",
          "type":"postback",
          "payload":"PAYBILL_PAYLOAD"
        }
      ]
    }
  ]
}

Batas Laju

Panggilan ke API Profil Messenger dibatasi hingga 10 panggilan API per interval 10 menit. Batas laju ini ditegakkan per Halaman.

Perhatikan bahwa panggilan ke menu tingkat pengguna dibatasi hingga 10 panggilan API per pengguna per interval 10 menit. Batas laju ini diberlakukan per Halaman.