Dokumentasi APIEnglish
Referensi API.
20 endpoint API v2. Setiap halaman memuat parameter, error, contoh dalam cURL, Node.js, PHP, dan Python, dan konsol Coba, dibuat dari kode server yang sama.
API v2
Satu API untuk WhatsApp (scan QR) dan WhatsApp Official: kirim teks, file, template, dan OTP, balas percakapan, kelola kontak, baca saluran dan template. Kunci tes hanya ke nomor uji.
- POST
/api/v2/messagesKirim pesan. Satu endpoint untuk WhatsApp (scan QR) dan WhatsApp Official: teks, file, template, atau kode OTP. - GET
/api/v2/messages/{id}Status pesan. Status dan error pesan yang dikirim kunci ini. - GET
/api/v2/conversationsDaftar percakapan. Percakapan dalam cakupan pembuat kunci, terbaru dulu. - GET
/api/v2/conversations/{id}Detail percakapan. Satu percakapan dalam cakupan pembuat kunci. - GET
/api/v2/conversations/{id}/messagesPesan dalam percakapan. Pesan satu percakapan, terbaru dulu. - POST
/api/v2/conversations/{id}/messagesBalas percakapan. Balas teks atau file di percakapan yang bisa dilihat pembuat kunci, di saluran mana pun yang dibalas Inbox. - GET
/api/v2/contactsCari kontak. Kontak dalam cakupan pembuat kunci, diperbarui terakhir dulu. - POST
/api/v2/contactsBuat kontak. Tambah kontak baru dengan nomor atau email. - GET
/api/v2/contacts/{id}Detail kontak. Satu kontak dalam cakupan pembuat kunci. - PATCH
/api/v2/contacts/{id}Ubah kontak. Ubah field kontak; hanya field yang dikirim yang berubah. - GET
/api/v2/channelsDaftar saluran. Nomor WhatsApp yang boleh dipakai kunci ini, dengan statusnya. - GET
/api/v2/templatesDaftar template. Template WhatsApp Official beserta variabel yang harus diisi. - POST
/api/v2/templatesAjukan template. Ajukan template WhatsApp Official baru untuk disetujui. - GET
/api/v2/webhooksDaftar webhook. Webhook bisnis ini, dengan event, kesehatan 7 hari, dan jumlah kiriman gagal. - POST
/api/v2/webhooksTambah webhook. Daftarkan URL HTTPS sistem Anda dan event yang ingin diterima. - GET
/api/v2/webhooks/{id}Detail webhook. Satu webhook dengan event dan kesehatannya. - PATCH
/api/v2/webhooks/{id}Ubah webhook. Ubah URL, event, keterangan, atau jeda dan aktifkan lagi. - DELETE
/api/v2/webhooks/{id}Hapus webhook. Hapus webhook beserta log kirimannya. - POST
/api/v2/webhooks/{id}/testKirim event uji. Kirim contoh satu event (ditandai `test: true`) sekarang, lalu lihat jawaban sistem Anda. - GET
/api/v2/meKunci saya. Jenis kunci, izin yang bisa dipakai sekarang, dan saluran yang boleh dipakai.