Langsung ke konten
Wbiztool

API Akun WhatsApp

API Status koneksi WhatsApp

Periksa apakah salah satu nomor WhatsApp Anda terhubung dan siap mengirim pesan. Gunakan sebelum kampanye, atau saat menunggu nomor yang baru dihubungkan selesai ditautkan. Gunakan endpoint ini, bukan /api/v1/whatsapp/status/<id>/ yang tidak berfungsi.

POSThttps://wbiztool.com/api/v1/whatsapp-client/status/

Body: JSON atau field formulir

Contoh singkat#

curl -X POST https://wbiztool.com/api/v1/whatsapp-client/status/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678
  }'

Ganti 12345, YOUR_API_KEY, dan 678 dengan nilai Anda sendiri. Lihat Autentikasi untuk mengetahui di mana menemukannya.

Parameter request#

client_idintegerwajib

API Client ID Anda dari Settings → API keys (Pengaturan → Kunci API).

api_keystringwajib

API key Anda dari halaman yang sama.

whatsapp_clientintegerwajib

ID nomor WhatsApp yang ingin diperiksa, dari WhatsApp settings (pengaturan WhatsApp), Daftar akun, atau whatsapp_client_id yang dikembalikan oleh Hubungkan nomor.

Menggunakan klien resmi#

Klien Python memanggil endpoint ini untuk Anda.

Python
from wbiztool_client import WbizToolClient

client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)

result = client.get_whatsapp_client_status(678)
print(result)

Klien Python memunculkan requests.exceptions.HTTPError ketika API mengembalikan HTTP 400 atau 403, jadi bungkus panggilan dengan try/except.

getWhatsAppClientStatus() di klien Node.js memanggil alamat yang tidak ada dan gagal dengan 404. Gunakan fetch seperti pada Contoh singkat.

Respons#

Jika kredensial Anda valid, request mengembalikan HTTP 200 dengan salah satu body berikut.

Nomor terhubung:

{ "message": "Connected", "status": 1 }

Nomor tidak terhubung:

{ "message": "Disconnected", "status": 0 }
FieldTipeDeskripsi
statusinteger1 jika nomor terhubung. 0 jika nomor tidak terhubung atau request gagal.
messagestringConnected, Disconnected, atau error.

Nomor yang sudah Anda hapus dari WhatsApp settings juga mengembalikan Disconnected.

Error#

PesanHTTPCara memperbaikinya
Auth Error200Kirim client_id, api_key, dan whatsapp_client berupa angka di body POST, sebagai JSON atau field formulir yang valid.
Invalid Client Id403Kirim client_id sebagai bilangan bulat, misalnya 12345.
Auth Error: invalid api key400Pastikan key tersebut ada, belum dihapus, dan milik client_id ini.
Auth Error 2200ID whatsapp_client tersebut tidak ada di workspace API key ini.
Demo Account can not access apis200Gunakan akun biasa.

Tips#

  • Sebelum mengirim: jika nomor pengirim terputus, pesannya menunggu di antrean sampai nomor tersebut terhubung kembali atau pesannya kedaluwarsa, jadi periksa status sebelum pengiriman besar. Pesan yang belum terkirim pada nomor yang terputus dihapus setelah 90 hari.
  • Setelah menghubungkan nomor: lakukan polling ke endpoint ini setiap beberapa detik sampai mengembalikan Connected. Webhook connected bisa tiba beberapa detik sebelum endpoint ini mengembalikan Connected, jadi lanjutkan polling hingga satu menit setelah event tersebut. Lihat Hubungkan nomor.
  • Semua nomor sekaligus: untuk mendapatkan status setiap nomor dalam satu panggilan, gunakan Daftar akun.