Memulai

Memulai dengan API Wbiztool

REST API Wbiztool memungkinkan software Anda mengirim pesan WhatsApp dari nomor WhatsApp Anda sendiri yang sudah terhubung. Gunakan API ini untuk mengirim update pesanan, pengingat, dan notifikasi dari aplikasi, CRM, situs web, atau alat otomatisasi Anda.

Halaman ini menjelaskan hal-hal yang dibutuhkan setiap request. Untuk mengirim pesan pertama Anda, langsung ke Kirim pesan.

Base URL#

Semua endpoint berada di bawah:

https://wbiztool.com/api/v1/

Sebagian besar endpoint menerima request POST. Anda dapat mengirim body sebagai JSON (application/json) atau sebagai field formulir (application/x-www-form-urlencoded). Untuk mengunggah file, gunakan multipart/form-data. Beberapa endpoint baca menggunakan GET; halaman setiap endpoint menyebutkan metodenya.

Sebelum memulai#

Buat akun di wbiztool.com/signup. Akun baru mendapatkan 50 pesan gratis.
Hubungkan nomor WhatsApp. Buka WhatsApp settings (pengaturan WhatsApp), klik connect, lalu scan kode QR dari WhatsApp di ponsel Anda.
Buat API key. Buka Settings → API keys (Pengaturan → Kunci API). Hanya pemilik workspace yang dapat membuat key. Setiap workspace dapat memiliki hingga 10 key.

Autentikasi#

Sebagian besar endpoint menerima kredensial Anda di body setiap request. API verifikasi nomor menggunakan header Authorization: Bearer sebagai gantinya; halaman-halamannya menjelaskan caranya.

client_idintegerwajib: API Client ID Anda, yang ditampilkan di Settings → API keys.
api_keystringwajib: Salah satu API key Anda dari halaman yang sama. Jaga kerahasiaannya: siapa pun yang memiliki key ini dapat mengirim pesan dari nomor Anda.
whatsapp_clientintegerSebagian besar endpoint pesan: ID nomor WhatsApp yang digunakan untuk mengirim, ditampilkan di kolom WhatsApp Client ID (ID klien WhatsApp) di WhatsApp settings. Halaman setiap endpoint menyebutkan apakah parameter ini diperlukan.

API key menentukan workspace mana yang dipakai oleh sebuah request. Jika Anda tergabung di lebih dari satu workspace, gunakan key yang dibuat di workspace yang ingin Anda gunakan untuk mengirim.

Jika sebuah key bocor, hapus key tersebut di halaman API keys. Key yang dihapus langsung berhenti berfungsi.

Request pertama Anda#

Contoh ini mengirim pesan teks dari nomor Anda yang terhubung. Ganti ID, key, dan nomor telepon dengan milik Anda.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

Respons "status": 1 dengan msg_id berarti pesan sudah masuk antrean. Kirim pesan menjelaskan setiap parameter dan menyediakan versi Python, Node.js, dan PHP.

Respons dan error#

Setiap respons adalah objek JSON dengan field status (kecuali health check /api/v1/status/, yang mengembalikan "status": 200):

"status": 1 berarti request berhasil.
"status": 0 berarti request gagal. Field message menjelaskan penyebabnya.

{ "status": 0, "message": "Auth Error: invalid api key" }

Error autentikasi yang umum:

Pesan	Arti
`Auth Error`	`client_id` atau `api_key` tidak ada, body bukan JSON atau data formulir yang valid, atau request bukan `POST`.
`Auth Error - Please send correct API key and Client id`	`api_key` tidak ada atau kosong.
`Invalid client id.` atau `Invalid Client Id`	`client_id` bukan bilangan bulat (atau, di beberapa endpoint, tidak dikirim). Kirim sebagai angka, misalnya `12345`.
`Auth Error: invalid api key`	Key tidak ada, sudah dihapus, atau bukan milik `client_id` ini.
`Demo Account can not access apis`	Akun demo tidak dapat menggunakan API.
`Not enough credits`	Paket Anda sudah tidak memiliki sisa pesan. Upgrade paket atau tunggu siklus penagihan berikutnya.

Siklus hidup pesan#

Pesan yang Anda kirim melalui API masuk antrean terlebih dahulu, lalu dikirim dari nomor WhatsApp Anda. Setiap pesan memiliki salah satu status berikut:

Status	Nama	Arti
`0`	Created (Dibuat)	Masuk antrean dan menunggu dikirim.
`1`	Sent (Terkirim)	Sudah dikirim dari nomor WhatsApp Anda.
`2`	Failed (Gagal)	Tidak dapat dikirim, misalnya karena nomornya tidak terdaftar di WhatsApp.
`3`	Cancelled (Dibatalkan)	Dibatalkan sebelum dikirim.
`4`	Expired (Kedaluwarsa)	Tidak terkirim sebelum batas waktu `expire_after_seconds`.

Nomor WhatsApp Anda harus tetap terhubung agar pesan dalam antrean bisa terkirim. Jika nomor pengirim terputus, pesannya menunggu di antrean sampai nomor tersebut terhubung kembali atau pesannya kedaluwarsa. Pesan yang belum terkirim pada nomor yang terputus dihapus setelah 90 hari.

Untuk memantau sebuah pesan, simpan msg_id dari respons, lalu kirim URL webhook saat mengirim pesan, atau panggil Status pesan.

Library klien resmi#

Wrapper untuk Python dan Node.js menangani autentikasi dan unggahan file untuk Anda. Library ini belum menangani setiap endpoint dengan benar, jadi periksa halaman setiap endpoint sebelum mengandalkan sebuah method klien.

pip install wbiztool-client

npm install wbiztool-client

Python: wbiztool-client di PyPI
Node.js: wbiztool-client di npm

Lebih suka tanpa kode? Lihat Aplikasi & integrasi untuk Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify, dan WordPress.

Jelajahi dokumentasi#

Panduan produk: gunakan dashboard Wbiztool, mulai dari menghubungkan nomor hingga kampanye, pengingat, dan Unibox.
API Pesan: kirim, jadwalkan, batalkan, dan pantau pesan.
API Akun WhatsApp: hubungkan nomor dan periksa statusnya.
API Verifikasi Nomor: periksa secara massal nomor mana yang terdaftar di WhatsApp.
API Pengingat: buat, lihat daftar, dan batalkan pengingat berulang.
API Media: unggah file, lalu lihat daftar atau ambil file tersebut.
Integrasi: penyiapan tanpa kode dan plugin.