API di Tempat Platform WhatsApp Business

Webhooks untuk API di Tempat

Berlangganan Webhooks untuk mendapatkan notifikasi tentang pesan yang diterima bisnis Anda dan pembaruan profil pelanggan. Lihat Ringkasan, Webhooks untuk informasi selengkapnya tentang Webhooks Platform WhatsApp Business.

Pengaturan Webhooks tidak akan memengaruhi nomor telepon pada Aplikasi WhatsApp Business Anda. Hanya setelah Anda memigrasi nomor Anda ke Platform WhatsApp Business, Anda tidak bisa lagi menggunakan nomor itu di Aplikasi WhatsApp Business.

Sebelum Memulai

Anda akan memerlukan:

  • Kode yang mendukung HTTPS dan memiliki sertifikat SSL yang valid
  • Endpoint URL panggilan balik yang dikonfigurasi untuk menerima permintaan masuk dari Coreapp
  • Endpoint URL panggilan yang menberikan tanggapan HTTPS 200 OK ketika notifikasi diterima

Coba Lagi

Jika notifikasi tidak tersampaikan karena alasan apa pun atau jika permintaan Webhooks memberikan kode status HTTP selain 200, kami mencoba ulang penyampaian notifikasi. Kami akan terus mencoba ulang pengiriman dengan waktu keterlambatan yang makin panjang hingga angka tertentu (biasanya 24 jam, meskipun ini mungkin berbeda-beda), atau sampai pengiriman berhasil.

Mengatur Endpoint URL Panggilan Balik Anda

Kirim permintaan PATCH ke endpoint /v1/settings/application dengan parameter webhooks diatur ke endpoint URL panggilan balik Anda. Parameter lain yang biasa dikonfigurasi adalah sent_status dan callback_persist.

Contoh Permintaan

PATCH /v1/settings/application
{
    "callback_persist": true,
    "sent_status": true,  // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
    "webhooks": { 
    	"url": "webhook.your-domain", 
        "message": {     // Available on v2.41.2 and above
        	"sent": false,
        	"delivered": true,
        	"read": false
       },
    }
}

Jika berhasil, tanggapan berisi 200 OK dengan null atau objek JSON.

KunjungiReferensi Pengaturan Aplikasi untuk informasi selengkapnya tentang mengonfigurasi aplikasi Anda, dan parameter Webhooks tambahan.

Muatan Notifikasi Webhooks

Setiap kali peristiwa pemicu terjadi, Platform WhatsApp Business melihat peristiwa tersebut dan mengirimkan notifikasi ke URL Webhooks yang telah Anda tentukan sebelumnya. Anda bisa mendapatkan dua jenis notifikasi:

  • Pesan diterima: Pemberitahuan ini mengabari Anda saat Anda menerima pesan. Ini juga bisa disebut sebagai "notifikasi masuk" di seluruh dokumentasi.
  • Notifikasi status pesan dan harga: Pemberitahuan ini memberi tahu Anda ketika status pesan telah berubah —contoh: pesan telah dibaca atau tersampaikan. Ini juga dapat disebut sebagai "notifikasi keluar" di seluruh dokumentasi.

Lihat Komponen untuk informasi tentang setiap kolom.

Notifikasi Kesalahan

{
    "errors": [ {
       "code": <error-code>,
       "title": "<error-title>",
       "details": "<error-description>",
       "href": "location for error detail"
    },
    {
       ...
    }
    ]
 }

Contoh Endpoint Aplikasi

Untuk menguji Webhooks, Anda dapat membuat contoh aplikasi dengan endpoint untuk menerima notifikasi.