Platform Messenger

Conversations API untuk Platform Messenger

Dokumen ini menjelaskan tentang cara mendapatkan informasi tentang percakapan Messenger dan Pengiriman Pesan Instagram. Anda bisa mendapatkan:

  • Daftar percakapan untuk Halaman Facebook Anda atau akun Profesional Instagram Anda
  • Daftar pesan dalam setiap percakapan
  • Detail tentang setiap pesan, termasuk kapan pesan dikirim dan dari siapa

Sebelum Memulai

Tutorial ini mengasumsi Anda telah membaca Ringkasan Platform Messenger dan Ringkasan Berkirim Pesan di Instagram dan menerapkan komponen yang dibutuhkan.

Anda memerlukan:

  • ID untuk Halaman Facebook untuk bisnis Anda atau Halaman Facebook yang terhubung ke akun Profesional Instagram Anda
  • Token akses Halaman yang diminta oleh seseorang yang dapat melakukan tugas MESSAGING atau MODERATE di Halaman
  • Akses Lanjutan diperlukan untuk mengakses percakapan antara bisnis Anda dan orang-orang yang tidak memiliki peran di aplikasi berkirim pesan Anda, akun Profesional Instagram Anda, Halaman Facebook Anda, atau bisnis Anda

Untuk percakapan Messenger antara orang-orang dan Halaman Anda, aplikasi Anda akan membutuhkan:

Untuk percakapan Pengiriman Pesan Instagram antara orang-orang dan akun Profesional Instagram Anda, aplikasi Anda akan membutuhkan:

  • Token akses Halaman yang diminta oleh orang yang dapat melakukan tugas MESSAGING di Halaman yang tertaut ke akun Instagram Business Anda
  • Izin instagram_basic, instagram_manage_messages, dan pages_manage_metadata
  • Aplikasi Anda harus dimiliki oleh bisnis terverifikasi

Batasan

  • Hanya gambar atau URL video untuk bagikan yang akan disertakan dalam data yang diberikan dalam panggilan ke API atau dalam notifikasi Webhooks.
  • Jika akun Anda tertaut menggunakan kode pribadi, seperti email atau nomor telepon, Anda tidak akan dapat mengambil percakapan di antara akun-akun ini. Hanya percakapan antara satu Pengguna Facebook dan satu akun Instagram yang akan tersedia. Masalah ini akan terselesaikan ketika aplikasi Anda telah disetujui untuk Akses Lanjutan. Jika Anda memiliki beberapa akun yang tertaut di Pusat Akun di aplikasi Instagram, Anda akan dapat mengambil percakapan antara semua akun tertaut.
  • Percakapan yang ada dalam folder Permintaan yang tidak aktif selama 30 hari tidak akan ditampilkan dalam panggilan API.

Anda dapat memanfaatkan API ini untuk melakukan sinkronisasi kotak masuk pada percakapan sebelumnya ketika akun Instagram Business baru terhubung ke aplikasi Anda.

Mendapatkan Daftar Percakapan

Untuk mendapatkan daftar percakapan, kirimkan permintaan GET ke endpoint /PAGE-ID/conversations dan sertakan parameter platform yang diatur ke instagram atau messenger.

Contoh Permintaan

Diformat agar mudah dibaca
curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/conversations
    ?platform=PLATFORM
    &access_token=PAGE-ACCESS-TOKEN"

Saat berhasil, aplikasi Anda akan menerima objek JSON dengan daftar ID untuk percakapan antara Anda dan seseorang dan saat terakhir pesan dikirimkan.

{
  "data": 
    {
      "id": "CONVERSATION-ID-1",  
      "updated_time": "UNIX-TIMESTAMP"
    },
    {
      "id": "CONVERSATION-ID-2",   
      "updated_time": "UNIX-TIMESTAMP"
    }
    ...
  ]
}

Menemukan percakapan dengan pengguna tertentu

Untuk mendapatkan percakapan antara akun Profesional Instagram Anda atau Facebook dan orang tertentu, kirimkan permintaanGETke endpoint /PAGE-ID/conversations dengan parameter platform dan parameter user_id diatur ke ID lingkup Instagram atau ID lingkup Halaman untuk orang tersebut.

Contoh Permintaan

Diformat agar mudah dibaca
curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/conversations
    ?platform=PLATFORM
    &user_id=INSTAGRAM-OR-PAGE-SCOPED-ID
    &access_token=PAGE-ACCESS-TOKEN"

Saat berhasil, aplikasi Anda akan menerima ID untuk percakapan.


{
  "data": [
      {
        "id": "CONVERSATION-ID"
      },
  ]
}

Mendapatkan Daftar Pesan dalam Percakapan

Untuk mendapatkan daftar pesan dalam percakapan, kirimkan permintaan GET ke endpoint /CONVERSATION-ID dan sertakan kolom messages.

curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/CONVERSATION-ID
    ?fields=messages
    &access_token=PAGE-ACCESS-TOKEN"

Saat berhasil, aplikasi Anda akan menerima daftar ID pesan dan waktu pembuatan setiap pesan.

{
  "messages": {
    "data": [
      {
        "id": "Message ID-1",      
        "created_time": "UNIX-TIMESTAMP-MOST-RECENT-MESSAGE"  
      },
      {
        "id": "Message ID-2",
        "created_time": "UNIX-TIMESTAMP"
      },
      {
        "id": "Message ID-3",
        "created_time": "UNIX-TIMESTAMP"
      },
...
    ]
  },
  "id": "Conversation ID", 
}

Mendapatkan informasi tentang Pesan

Untuk mendapatkan informasi tentang pesan, seperti pengirim, penerima, dan konten pesan, kirimkan permintaan GET ke endpoint /MESSAGE-ID dengan kolom yang Anda minati.

Kolom default-nya adalah id dan created_time.

Catatan: Pertanyaan ke endpoint /CONVERSATION-ID akan memberikan semua ID pesan dalam percakapan. Namun, Anda hanya bisa mendapatkan detail tentang 20 pesan terbaru dalam percakapan. Jika Anda meng-kueri pesan yang lebih lama dari 20 yang lalu, Anda akan melihat pesan kesalahan bahwa pesan telah dihapus. 

curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/MESSAGE-ID
    ?fields=id,created_time,from,to,message
    &access_token=PAGE-ACCESS-TOKEN"

Setelah berhasil, aplikasi akan menerima tanggapan JSON berikut. Dalam contoh ini, pelanggan mengirim pesan teks biasa ke akun Profesional Instagram Anda.

{
  "id": "aWdGGiblWZ...",
  "created_time": "2022-07-12T19:11:07+0000",
  "to": {
    "data": [
      {
        "username": "INSTAGRAM-PROFESSIONAL-ACCOUNT-USERNAME",
        "id": "INSTAGRAM-PROFESSIONAL-ACCOUNT-ID"
      }
    ]
  },
  "from": {
    "username": "INSTAGRAM-USERNAME",
    "id": "INSTAGRAM-SCOPED-ID"
  },
  "message": "Hi Kitty!"
}

Pelajari selengkapnya

Kunjungi referensi kami untuk:

Dukungan Developer