Versi Graph API

Messenger Profile API

Profil Messenger untuk Halaman Anda adalah tempat Anda menetapkan properti yang menentukan berbagai aspek dari fitur Platform Messenger berikut. Untuk informasi selengkapnya, lihat tabel Properti Profil Messenger di bawah.

API Profil Messenger memungkinkan Anda untuk mengatur, memperbarui, mengambil, dan menghapus properti dari Halaman Profil Messenger.

Izin

Token akses halaman dengan izin pages_messaging diperlukan untuk berinteraksi dengan endpoint ini.

Aplikasi dalam Mode Pengembangan, pengaturan Profil Messenger hanya akan dapat dilihat oleh orang dengan peran di aplikasi.

Konten

URI Permintaan

https://graph.facebook.com/v19.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>

Properti Profil Messenger

Properti berikut mungkin disertakan dalam profil Messenger untuk Halaman Anda. Lihat deskripsi pada tabel di bawah untuk jenis dan tujuan setiap properti.

Properti Jenis Deskripsi

get_started

Objek

Muatan yang akan dikirim sebagai peristiwa messaging_postbacks ketika seseorang mengetuk tombol 'mulai' di layar sambutan Halaman Messenger Anda.


Untuk selengkapnya, lihat Referensi Tombol Mulai.

greeting

Array<Object>

Array berbagai pesan ucapan salam khusus locale untuk ditampilkan di layar sambutan Halaman Messenger Anda.


Untuk selengkapnya, lihat Referensi Teks Salam.

ice_breakers

Array<Object>

Array dengan objek pencair suasana.


Untuk selengkapnya, lihat Referensi Pencair Suasana.

persistent_menu

Array<Object>

Array tombol ajakan bertindak untuk disertakan di menu persisten.


Untuk selengkapnya, lihat Referensi Menu Persisten.

whitelisted_domains

Array<String>

Daftar domain daftar putih. Diperlukan untuk Halaman yang menggunakan SDK Ekstensi Messenger dan plugin kotak centang.


Untuk selengkapnya, lihat Referensi Daftar Putih Domain.

account_linking_url

String

URL panggilan balik autentikasi. Harus menggunakan protokol https.


Untuk selengkapnya, lihat Referensi URL Penautan Akun.

home_url

Objek

URL yang akan ditampilkan di tampilan web Messenger ketika seseorang membuka Plugin Obrolan Messenger Anda.


Tidak berlaku untuk semua operasi (GET, POST, DELETE) di v7.0+.

commands

Array<Object>

Argumen opsional. Jika ada, tidak boleh nol.


Untuk informasi selengkapnya, lihat Referensi Perintah.

target_audience (Dihentikan)

Objek

Set kriteria yang menentukan pemirsa tempat Messenger Anda akan muncul di Tab Temukan.


Untuk selengkapnya, lihat Referensi Pengaturan Pemirsa Target.

subject_to_new_eu_privacy_rules

Boolean

Bendera boolean yang menentukan apakah halaman tersebut terpengaruh oleh Pembaruan API Messenger untuk Eropa. Properti ini hanya tersedia untuk permintaan GET.

Mengambil Properti

Mengambil nilai saat ini dari satu atau beberapa properti Profil Messenger berdasarkan nama.

Parameter Permintaan

Parameter berikut termasuk dalam string kueri permintaan:

ParameterDeskripsi

kolom

Daftar properti Profil Messenger yang dipisahkan koma untuk diambil.

Contoh Permintaan

curl -X GET "https://graph.facebook.com/v19.0/me/messenger_profile?fields=whitelisted_domains,greeting&access_token=<PAGE_ACCESS_TOKEN>"

Contoh Tanggapan

Nilai saat ini dari properti yang diminta akan diberikan dalam array data:

{
   "data": [
        {
          "whitelisted_domains": [
            "https://facebook.com/"
          ],
          "greeting": [
            {
               "locale": "default",
               "text": "Hello!"
            },
            {
               "locale": "en_US",
               "text": "Timeless apparel for the masses."
            }
         ]
      }
   ]
}

Mengatur/Memperbarui Properti

Mengatur nilai satu atau beberapa properti Profil Messenger. Hanya properti yang diatur dalam badan permintaan yang akan ditimpa.

Contoh Permintaan

curl -X POST -H "Content-Type: application/json" -d '{
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  ...
}' "https://graph.facebook.com/v18.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Contoh Tanggapan

{
    "result": "success"
}

Menghapus Properti

Menghapus satu atau beberapa properti Profil Messenger. Hanya properti yang ditentukan dalam array fields yang akan dihapus.

Contoh Permintaan

curl -X DELETE -H "Content-Type: application/json" -d '{
  "fields": [
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    ...
  ]
}' "https://graph.facebook.com/v19.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Contoh Tanggapan

{
    "result": "success"
}

Batas Laju

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