Bermula

Bermula dengan API Wbiztool

REST API Wbiztool membolehkan perisian anda menghantar mesej WhatsApp dari nombor WhatsApp anda sendiri yang telah disambungkan. Gunakannya untuk menghantar kemas kini pesanan, peringatan dan makluman dari aplikasi, CRM, laman web atau alat automasi anda.

Halaman ini menerangkan perkara yang diperlukan oleh setiap permintaan. Untuk menghantar mesej pertama anda, terus ke Hantar mesej.

URL asas#

Semua endpoint berada di bawah:

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

Kebanyakan endpoint menerima permintaan POST. Anda boleh menghantar badan permintaan sebagai JSON (application/json) atau sebagai medan borang (application/x-www-form-urlencoded). Untuk memuat naik fail, gunakan multipart/form-data. Beberapa endpoint bacaan menggunakan GET; halaman setiap endpoint menunjukkan kaedahnya.

Sebelum anda bermula#

Buat akaun di wbiztool.com/signup. Akaun baharu termasuk 50 mesej percuma.
Sambung nombor WhatsApp. Buka tetapan WhatsApp, klik sambung dan imbas kod QR dari WhatsApp di telefon anda.
Cipta kunci API. Pergi ke Settings → API keys (Tetapan → Kunci API). Hanya pemilik ruang kerja boleh mencipta kunci. Setiap ruang kerja boleh mempunyai sehingga 10 kunci.

Pengesahan identiti#

Kebanyakan endpoint menerima kelayakan anda dalam badan setiap permintaan. API pengesahan nombor pula menggunakan pengepala Authorization: Bearer; halamannya menerangkan caranya.

client_idintegerwajib: API Client ID anda, dipaparkan di Settings → API keys.
api_keystringwajib: Salah satu kunci API anda dari halaman yang sama. Rahsiakannya: sesiapa yang mempunyai kunci ini boleh menghantar mesej dari nombor anda.
whatsapp_clientintegerKebanyakan endpoint mesej: ID nombor WhatsApp yang digunakan untuk menghantar, dipaparkan dalam lajur WhatsApp Client ID di tetapan WhatsApp. Halaman setiap endpoint menyatakan sama ada ia diperlukan.

Kunci API menentukan ruang kerja yang digunakan oleh sesuatu permintaan. Jika anda ahli lebih daripada satu ruang kerja, gunakan kunci yang dicipta dalam ruang kerja yang anda mahu gunakan untuk menghantar.

Jika kunci terdedah, padamkannya di halaman kunci API. Kunci yang dipadam berhenti berfungsi serta-merta.

Permintaan pertama anda#

Contoh ini menghantar mesej teks dari nombor anda yang disambungkan. Gantikan ID, kunci dan nombor telefon dengan nilai anda sendiri.

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 bermaksud mesej telah dimasukkan ke dalam baris gilir. Hantar mesej menerangkan setiap parameter dan menyediakan versi Python, Node.js dan PHP.

Respons dan ralat#

Setiap respons ialah objek JSON dengan medan status (kecuali semakan kesihatan /api/v1/status/, yang memulangkan "status": 200):

"status": 1 bermaksud permintaan berjaya.
"status": 0 bermaksud permintaan gagal. Medan message menerangkan sebabnya.

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

Ralat pengesahan yang biasa:

Mesej	Maksud
`Auth Error`	`client_id` atau `api_key` tiada, badan permintaan bukan JSON atau data borang yang sah, atau permintaan bukan `POST`.
`Auth Error - Please send correct API key and Client id`	`api_key` tiada atau kosong.
`Invalid client id.` atau `Invalid Client Id`	`client_id` bukan nombor bulat (atau, pada sesetengah endpoint, tiada). Hantarkannya sebagai nombor, contohnya `12345`.
`Auth Error: invalid api key`	Kunci tidak wujud, telah dipadam atau bukan milik `client_id` ini.
`Demo Account can not access apis`	Akaun demo tidak boleh menggunakan API.
`Not enough credits`	Pelan anda tiada baki mesej. Naik taraf pelan atau tunggu kitaran pengebilan seterusnya.

Kitaran hayat mesej#

Mesej yang anda hantar melalui API dimasukkan ke dalam baris gilir dahulu, kemudian dihantar dari nombor WhatsApp anda. Setiap mesej mempunyai salah satu status berikut:

Status	Nama	Maksud
`0`	Created	Dalam baris gilir dan menunggu untuk dihantar.
`1`	Sent	Telah dihantar dari nombor WhatsApp anda.
`2`	Failed	Tidak dapat dihantar, contohnya kerana nombor itu tiada di WhatsApp.
`3`	Cancelled	Dibatalkan sebelum dihantar.
`4`	Expired	Tidak dihantar sebelum tarikh akhir `expire_after_seconds`.

Nombor WhatsApp anda mesti kekal disambungkan supaya mesej dalam baris gilir dapat dihantar. Jika nombor yang digunakan untuk menghantar terputus sambungan, mesejnya menunggu dalam baris gilir sehingga nombor itu disambungkan semula atau mesej tamat tempoh. Mesej yang belum dihantar pada nombor yang terputus sambungan akan dibuang selepas 90 hari.

Untuk menjejaki mesej, simpan msg_id daripada respons dan sama ada hantar URL webhook semasa menghantarnya, atau panggil Status mesej.

Pustaka klien rasmi#

Pembalut untuk Python dan Node.js mengendalikan pengesahan identiti dan muat naik fail untuk anda. Pembalut ini belum menyokong setiap endpoint dengan betul, jadi semak halaman setiap endpoint sebelum anda bergantung pada sesuatu kaedah klien.

pip install wbiztool-client

npm install wbiztool-client

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

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

Layari dokumentasi#

Panduan produk: gunakan papan pemuka Wbiztool, daripada menyambung nombor hingga kempen, peringatan dan Unibox.
API mesej: hantar, jadualkan, batalkan dan jejaki mesej.
API akaun WhatsApp: sambung nombor dan semak statusnya.
API pengesahan nombor: semak secara pukal nombor yang menggunakan WhatsApp.
API peringatan: cipta, senaraikan dan batalkan peringatan berulang.
API media: muat naik fail, kemudian senaraikan atau dapatkannya.
Integrasi: persediaan tanpa kod dan plugin.