Dokumen ini sudah diperbarui.
Terjemahan ke Bahasa Indonesia belum selesai.
Bahasa Inggris diperbarui: 10 Sep

Ringkasan

API Pengelolaan WhatsApp Business memungkinkan Anda untuk mengelola aset bisnis terkait WhatsApp, seperti Akun WhatsApp Business dan template pesan. API dibuat berdasarkan Marketing API dan memanfaatkan beberapa endpoint-nya, sehingga dokumentasi ini mungkin berisi tautan ke dokumentasi Marketing API jika diperlukan.

Persyaratan

Token Akses

Platform ini mendukung jenis token akses berikut. Jenis yang Anda gunakan tergantung pada siapa yang akan menggunakan aplikasi Anda, dan apakah Anda adalah Partner Solusi atau bukan.

Token Akses Pengguna Sistem

Token akses Pengguna Sistem mewakili Anda, bisnis atau organisasi Anda, atau orang-orang dalam bisnis atau organisasi Anda. Keuntungan utama dari token ini adalah tidak kedaluwarsa, dan dapat mewakili layanan otomatis dalam bisnis Anda yang tidak memerlukan input pengguna.

Token akses Pengguna Sistem adalah satu-satunya jenis token yang dapat digunakan oleh Partner Solusi untuk berbagi lini kredit dengan pelanggan yang di-onboarding.

Sebelum dapat membuat token akses Pengguna Sistem, Anda harus membuat pengguna sistem. Sebagian besar endpoint memeriksa apakah pengguna yang diidentifikasi oleh token memiliki akses ke sumber daya yang di-kueri. Jika pengguna tidak memiliki akses ke sumber daya, permintaan akan ditolak dengan kode kesalahan 200.

Pengguna sistem dapat berupa karyawan atau admin.

Pengguna Sistem Karyawan

Pengguna sistem karyawan harus diberikan akses ke tiap-tiap Akun WhatsApp Business yang dimiliki oleh, atau dibagikan dengan, bisnis Meta. Jika aplikasi Anda hanya membutuhkan akses ke beberapa Akun WhatsApp Business yang Anda miliki, pengguna sistem karyawan sudah cukup.

Setelah dibuat, Anda harus memberikan akses aset bisnis Parsial atau Penuh untuk setiap Akun WhatsApp Business yang perlu diakses oleh pengguna sistem.

Pengguna Sistem Admin

Secara default, pengguna sistem admin memiliki akses penuh ke semua Akun WhatsApp Business dan aset mereka yang dimiliki oleh atau dibagikan dengan Anda atau bisnis Anda.

Pengguna sistem admin berguna jika aplikasi Anda perlu mengakses Akun WhatsApp Business yang baru saja dibagikan dengan bisnis Anda; jika Anda menggunakan pengguna sistem karyawan, Anda harus secara manual memberikan akses aset bisnis ke setiap Akun WhatsApp Business yang telah dibagikan dengan Anda.

Perhatikan bahwa Anda dapat mengganti akses aset bisnis default pengguna sistem admin dengan memberikan akses parsial berdasarkan Akun Bisnis WhatsApp. Lihat Akses Aset Bisnis untuk mempelajari cara mengatur dan mengganti akses.

Membuat Pengguna Sistem

Untuk membuat pengguna sistem:

  1. Masuk ke Meta Business Suite.
  2. Temukan akun bisnis Anda di menu pilihan kiri atas dan klik ikon Pengaturan (rodagigi).
  3. Klik Pengaturan bisnis.
  4. Buka Pengguna > Pengguna sistem.
  5. Klik tombol Tambahkan dan buat pengguna sistem admin atau karyawan.

Membuat Token Akses Pengguna Sistem

Untuk membuat token akses Pengguna Sistem setelah membuat pengguna sistem:

  1. Masuk ke Meta Business Suite.
  2. Temukan akun bisnis Anda di menu pilihan kiri atas dan klik ikon Pengaturan (rodagigi).
  3. Klik Pengaturan bisnis.
  4. Buka Pengguna > Pengguna sistem.
  5. Pilih pengguna sistem yang sesuai dari daftar pengguna sistem.
  6. Klik tombol Buat token baru.
  7. Pilih aplikasi yang akan menggunakan token.
  8. Pilih izin Graph API apa pun yang dibutuhkan aplikasi agar berfungsi dengan baik dan membuat token.

Token Akses Pengguna Sistem Integrasi Bisnis

Token akses Pengguna Sistem Integrasi Bisnis masuk lingkup pelanggan yang telah di-onboarding dan sebaiknya digunakan oleh Penyedia Layanan Teknologi dan Partner Solusi saat mengakses data pelanggan yang telah di-onboarding.

Token ini berguna untuk aplikasi yang melakukan tindakan terprogram, otomatis pada Akun WhatsApp Business pelanggan, tanpa harus mengandalkan input pengguna aplikasi, atau memerlukan autentikasi ulang di masa mendatang.

Untuk membuat token akses Pengguna Sistem Integrasi Bisnis, Anda harus menerapkan Pendaftaran Tersemat (dikonfigurasikan dengan Facebook Login for Business) dan menukar kode yang diberikan kepada Anda ketika pelanggan menyelesaikan alur.

Lihat dokumen Pendaftaran Tersemat dan token akses Pengguna Sistem Integrasi Bisnis untuk mempelajari selengkapnya tentang token ini dan cara membuatnya.

Token Akses Pengguna

Meski token akses pengguna didukung dan dapat digunakan oleh semua developer aplikasi, Anda mungkin hanya akan menggunakannya ketika pertama kali menggunakan Dasbor Aplikasi untuk mengirim pesan uji pertama Anda. Saat Anda mengembangkan aplikasi, kemungkinan besar Anda akan beralih ke token akses Pengguna Sistem (dan akhirnya token akses Pengguna Sistem Bisnis, jika Anda adalah Penyedia Layanan Teknologi atau Partner Solusi). Ini karena token akses pengguna kedaluwarsa dengan cepat, sehingga Anda harus terus membuat yang baru setiap beberapa jam.

Ada beberapa cara untuk membuat token akses Pengguna:

  • Akses panel Dasbor Aplikasi > WhatsApp > Pengaturan API. Panel ini selalu membuat token akses Pengguna baru setiap kali Anda mengunjunginya. Token akan secara otomatis masuk lingkup pengguna Anda, karena Anda masuk ke akun developer Anda ketika mengakses panel.
  • Menggunakan Graph API Explorer.
  • Menerapkan Facebook Login.

Menggunakan Token dalam Permintaan

Saat membuat permintaan API, sertakan token Anda dalam header permintaan otorisasi, didahului dengan Bearer. Contoh:

curl 'https://graph.facebook.com/v18.0/102290129340398/message_templates' \
-H 'Authorization: Bearer EAAJB...' \

Akses Aset Bisnis

Setelah membuat pengguna sistem, Anda harus mengatur tingkat akses aset bisnis. Banyak endpoint mewajibkan pengguna sistem yang tokennya disertakan dalam permintaan API mendapatkan akses aset bisnis Parsial atau Penuh ke Akun WhatsApp Business yang di-kueri (atau asetnya). Jika pengguna sistem tidak memiliki akses ini, endpoint ini akan menampilkan kode kesalahan 200.

Harap diperhatikan bahwa jika Anda mengatur akses aset bisnis pengguna sistem pada Akun WhatsApp Business ke akses Parsial, Anda dapat membatasi akses lebih lanjut ke aset atau tindakan tertentu pada Akun WhatsApp Business. Contoh: jika Anda memiliki bisnis besar dan ingin departemen tertentu hanya memiliki akses baca ke template Akun WhatsApp Business dan data nomor telepon bisnis, Anda dapat membuat pengguna sistem untuk departemen tersebut dan mengatur akses granular ke hanya lihat untuk data tersebut.

Untuk mengatur akses aset bisnis pada Akun WhatsApp Business:

  1. Masuk ke Meta Business Suite.
  2. Temukan akun bisnis Anda di menu pilihan kiri atas dan klik ikon Pengaturan (rodagigi).
  3. Buka Akun > Akun WhatsApp.
  4. Pilih Akun WhatsApp Business yang sesuai.
  5. Pilih tab Akses Akun WhatsApp.
  6. Klik tombol +Tambahkan orang.
  7. Pilih pengguna sistem yang sesuai dan tetapkan level akses yang sesuai pada Akun WhatsApp Business.

Menguji Endpoint

Kami merekomendasikan penggunaan koleksi Postman kami atau cURL saat menguji endpoint. Meskipun Anda dapat menggunakan fitur Graph API Explorer, fitur ini meneruskan token sebagai parameter string kueri, yang merupakan hal yang tidak kami sarankan (sebaiknya teruskan token di header permintaan).

Mendapatkan Informasi tentang Bisnis

Untuk mendapatkan informasi tentang bisnis, kirimkan permintaan GET ke endpoint WhatsAppBusinessAccount, dengan <WHATSAPP_BUSINESS_ACCOUNT_ID> adalah ID Akun WhatsApp Business Anda.

Contoh Permintaan

curl -i -X GET 'https://graph.facebook.com/v21.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Contoh Tanggapan

{
  "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
  "name": "Your WhatsApp Business Account Name",
  "timezone_id": "1",
  "message_template_namespace": "05155c78_261e_4b2f_82b3_d7958d4cf75f"
}

Untuk mendapatkan informasi spesifik tentang bisnis, seperti nama, template pesan dan nomor telepon, kirimkan permintaan GET ke endpoint WhatsAppBusinessAccount, dengan <WHATSAPP_BUSINESS_ACCOUNT_ID> adalah ID Akun WhatsApp Business Anda dan atur parameter fields ke daftar item yang ingin ditampilkan.

Contoh Permintaan

curl -i -X GET 'https://graph.facebook.com/v21.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=id,name,message_templates,phone_numbers' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Contoh Tanggapan

{
  "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
  "name": "Your WhatsApp Business Account Name",
  "message_templates": {
    "data": [
      {
        "name": "hello_world",
        "components": [
          {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Hello World"
          },
          {
            "type": "BODY",
            "text": "Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform. Thank you for taking the time to test with us."
          },
          {
            "type": "FOOTER",
            "text": "WhatsApp Business Team"
          }
        ],
        "language": "en_US",
        "status": "APPROVED",
        "category": "ACCOUNT_UPDATE",
        "id": "307191531401674"
      },
      {
        "name": "sample_flight_confirmation",
        "components": [
          {
            "type": "HEADER",
            "format": "DOCUMENT"
          },
          {
            "type": "BODY",
            "text": "Confirmamos tu vuelo a {{1}}-{{2}} para el {{3}}."
          },
          {
            "type": "FOOTER",
            "text": "Este mensaje proviene de un negocio no verificado."
          }
        ],
        "language": "es",
        "status": "APPROVED",
        "category": "TICKET_UPDATE",
      },
      ...
    

Batas Laju

Permintaan yang dibuat oleh aplikasi Anda ke API Pengelolaan WhatsApp Business dihitung berdasarkan jumlah aplikasi Anda. Jumlah panggilan aplikasi adalah jumlah panggilan yang dapat dilakukan selama satu jam bergulir. Untuk API Pengelolaan WhatsApp Business berikut, aplikasi Anda dapat melakukan 200 panggilan per jam, per aplikasi, per akun WhatsApp Business (WABA) secara default. Untuk WABA aktif dengan minimal satu nomor telepon terdaftar, aplikasi Anda dapat melakukan 5.000 panggilan per jam, per aplikasi, per WABA aktif.
Jenis Panggilan Endpoint

GET

/{whatsapp-business-account-id}

GET, POST, dan DELETE

/{whatsapp-business-account-id}/assigned_users

GET

/{whatsapp-business-account-id}/phone_numbers

GET, POST, dan DELETE

/{whatsapp-business-account-id}/message_templates

GET, POST, dan DELETE

/{whatsapp-business-account-id}/subscribed_apps

GET

/{whatsapp-business-account-to-number-current-status-id}

Untuk API Lini Kredit berikut, aplikasi Anda dapat melakukan 5.000 panggilan per jam, per aplikasi.
Jenis Panggilan Endpoint

GET

/{business-id}/extendedcredits

POST

/{extended-credit-id}/whatsapp_credit_sharing_and_attach

GET dan DELETE

/{allocation-config-id}

GET

/{extended-credit-id}/owning_credit_allocation_configs

Untuk menghindari menekan batas laju, kami merekomendasikan penggunaan Webhooks untuk melacak pembaruan status template pesan, nomor telepon, dan WABA.

Untuk informasi selengkapnya tentang cara mendapatkan penggunaan laju Anda saat ini, lihat Header.

Pelajari Selengkapnya

Langkah Berikutnya