Webhooks untuk Platform WhatsApp Business

Blog WhatsApp Business

Menggunakan Node.js untuk menerapkan Webhooks

Webhooks memungkinkan Anda untuk menerima notifikasi HTTP realtime tentang perubahan untuk objek tertentu. Contoh: kami dapat mengirimi Anda notifikasi saat pengguna mengirimi Anda pesan atau saat status template pesan telah berubah. Hal ini membuat Anda tidak perlu meng-kueri API kami untuk perubahan pada objek yang mungkin atau mungkin tidak terjadi, dan membantu Anda terhindar dari mencapai batas laju Anda.

Dokumen ini menyediakan ringkasan Webhooks dan berlaku untuk API Pengelolaan WhatsApp Business, Cloud API Platform WhatsApp Business, dan API di Tempat Platform WhatsApp Business.

Objek, Kolom, dan Nilai

Setiap API dapat memiliki beberapa jenis objek, jadi setiap kali Anda mengonfigurasi Webhooks, Anda harus terlebih dahulu memilih jenis objek. Karena objek yang berbeda memiliki kolom yang berbeda, maka Anda harus berlangganan kolom tertentu untuk jenis objek tersebut. Setiap kali ada perubahan nilai dari setiap kolom objek yang Anda telah berlangganan, kami akan mengirimi Anda notifikasi.

Notifikasi dikirimkan kepada Anda sebagai permintaan POST HTTP dan berisi payload JSON yang menggambarkan perubahan tersebut.

Webhooks yang Tersedia

Tabel berikut menjelaskan informasi yang dapat Anda terima dari Webhooks.

API	Objek
Cloud API	Pelanggan melakukan tindakan seperti membalas pesan bisnis Pelanggan memperbarui nomor teleponnya Pesan dikirim oleh bisnis, disampaikan kepada pelanggan, atau dibaca oleh pelanggan, termasuk informasi harga Terjadi kesalahan untuk pesan
API di Tempat	Pelanggan melakukan tindakan seperti membalas pesan bisnis Pelanggan memperbarui nomor teleponnya Pesan dikirim oleh bisnis, disampaikan kepada pelanggan, atau dibaca oleh pelanggan, termasuk informasi harga Terjadi kesalahan untuk pesan
WhatsApp Business Management API	Perubahan status akun bisnis resmi dan status nama tampilan Perubahan status untuk tinjauan Akun WhatsApp Business Informasi akun WhatsApp Business telah diperbarui, termasuk informasi untuk pelanggaran kebijakan Kemampuan untuk Akun WhatsApp Business telah diubah, seperti perubahan jumlah percakapan per nomor telepon Template pesan telah disetujui, ditolak, atau dinonaktifkan Nama tampilan yang terkait dengan nomor telepon telah disetujui atau ditolak Status terkait kualitas untuk nomor telepon telah berubah

Contoh Notifikasi Pesan Teks

Contoh berikut mewakili notifikasi Webhooks yang dikirimkan kepada Anda ketika pengguna telah mengirimi Anda pesan teks.

Cloud API

Untuk Cloud API, objek selalu whatsapp_business_account, tetapi field akan menjadi indikasi dari jenis informasi yang dikirim.

{
  "object": "whatsapp_business_account",
  "entry": [{
    "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
    "changes": [{
      "value": {
        "messaging_product": "whatsapp",
        "metadata": {
          "display_phone_number": PHONE_NUMBER,
          "phone_number_id": PHONE_NUMBER_ID
        },
        "contacts": [{
          "profile": {
            "name": "NAME"
          },
          "wa_id": PHONE_NUMBER
        }],
        "messages": [{
          "from": PHONE_NUMBER,
          "id": "wamid.ID",
          "timestamp": TIMESTAMP,
          "text": {
            "body": "MESSAGE_BODY"
          },
          "type": "text"
        }]
      },
      "field": "messages"
    }]
  }]
}

On-Premises API

Untuk API di Tempat, karena klien Anda mengirim Webhooks alih-alih Meta, objeknya adalah contacts dan messages, errors, atau statuses dan pricing.

{
  "contacts": [{
    "profile": {
      "name": "NAME"
    },
    "wa_id": "WHATSAPP_BUSINESS_ACCOUNT_ID"
  }],
  "messages":[{
    "from": "PHONE_NUMBER",
    "id": "wamid.ID",
    "timestamp": "TIMESTAMP",
    "text": {
      "body": "MESSAGE_BODY"
    },
    "type": "text"
  }]
}

Server HTTPS

Webhooks dikirim menggunakan HTTPS, sehingga server Anda harus dapat menerima dan memproses permintaan HTTPS, dan harus telah menginstal sertifikat TLS/SSL yang valid. Sertifikat yang ditandatangani sendiri tidak didukung.

Pelajari Selengkapnya

Pelajari selengkapnya tentang Webhooks untuk API tertentu.

Langkah Berikutnya

Memulai - Menentukan API mana yang tepat untuk bisnis Anda.
Nama Tampilan – Siapkan nama bisnis yang ditampilkan dalam pesan WhatsApp.
Nomor Telepon - Asosiasikan nomor telepon dengan Akun WhatsApp Business Anda
Harga – Pelajari tentang harga dan cara menyiapkan pembayaran.

Platform WhatsApp Business | Cloud API | API di Tempat | API Pengelolaan Bisnis