Langsung ke konten
Wbiztool

API Akun WhatsApp

API Daftar nomor WhatsApp terhubung

Dapatkan nomor WhatsApp di workspace Anda yang sedang terhubung saat ini. Gunakan untuk membiarkan pengguna memilih nomor pengirim, atau untuk menemukan ID whatsapp_client bagi panggilan API lainnya.

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

Body: JSON atau field formulir

Hanya nomor yang terhubung yang dikembalikan. Untuk melihat juga nomor yang terputus, gunakan Daftar akun.

Contoh singkat#

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

Ganti 12345 dan YOUR_API_KEY 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. Daftar yang dikembalikan adalah untuk workspace tempat key ini dibuat.

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.list_whatsapp_clients()
for number in result.get("whatsapp_clients", []):
    print(number["whatsapp_client_id"], number["whatsapp_client_number"])

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

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

Respons#

Request yang berhasil mengembalikan HTTP 200:

{
  "message": "okay",
  "whatsapp_clients": [
    {
      "id": 678,
      "whatsapp_client_id": 678,
      "whatsapp_client_number": "919876543210",
      "is_connected": true
    }
  ],
  "status": 1
}
FieldTipeDeskripsi
statusinteger1 jika berhasil, 0 jika request gagal.
messagestringokay jika berhasil, selain itu berisi error.
whatsapp_clientsarrayNomor Anda yang terhubung. Kosong jika tidak ada yang terhubung. Hanya ada jika berhasil.
whatsapp_clients[].whatsapp_client_idintegerID nomor tersebut. Kirim sebagai whatsapp_client di panggilan API lainnya.
whatsapp_clients[].idintegerNilainya sama dengan whatsapp_client_id.
whatsapp_clients[].whatsapp_client_numberstringNomor telepon seperti yang disimpan saat nomor ditambahkan.
whatsapp_clients[].is_connectedbooleanSelalu true, karena hanya nomor yang terhubung yang ditampilkan.

Urutan daftar tidak dijamin. Urutkan berdasarkan whatsapp_client_id jika urutan penting.

Error#

PesanHTTPCara memperbaikinya
Auth Error200Kirim client_id dan api_key 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.

Request yang bukan POST mengembalikan objek kosong {}. Masalah server yang tidak terduga mengembalikan HTTP 500 dengan body HTML, jadi pastikan respons berupa JSON sebelum membaca status.

Tips#

  • Daftar kosong: "whatsapp_clients": [] berarti tidak ada nomor yang terhubung di workspace ini. Hubungkan nomor di WhatsApp settings (pengaturan WhatsApp) atau dengan Hubungkan nomor.
  • Beberapa workspace: API key menentukan workspace mana yang ditampilkan. Gunakan key yang dibuat di workspace yang Anda inginkan.
  • Hanya satu nomor: untuk memeriksa satu nomor, gunakan Status koneksi.