Langsung ke konten
WbizTool

API Akun WhatsApp

API Daftar akun WhatsApp

Gunakan API ini untuk mendapatkan daftar lengkap semua nomor WhatsApp Anda beserta status koneksinya, dalam satu panggilan. Berbeda dengan Daftar nomor terhubung, API ini juga menyertakan nomor yang terputus.

POSThttps://wbiztool.com/api/v1/whatsapp/accounts/

Body: JSON atau field formulir

PerbedaanDaftar akunDaftar nomor terhubung
Menyertakan nomor yang terputus dan dihapusYaTidak
Key setiap itemwhatsapp_client_id, whatsapp_number, statusid, whatsapp_client_id, whatsapp_client_number, is_connected
message saat berhasilTidak disertakanokay

Contoh singkat#

curl -X POST https://wbiztool.com/api/v1/whatsapp/accounts/ \
  -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.

Kedua klien resmi tidak memiliki method untuk endpoint ini, jadi panggil secara langsung seperti pada contoh.

Parameter request#

AuthorizationheaderDisarankan

Bearer YOUR_API_KEY: kunci API Anda dari Pengaturan → Kunci API. Dengan header ini, client_id dan api_key boleh tidak dikirim di body; jika keduanya dikirim, kunci valid di header yang dipakai. Lihat Mengirim kunci di header.

client_idintegerTanpa header Authorization

API Client ID Anda dari Pengaturan → Kunci API. Opsional jika memakai header; jika Anda mengirimnya, nilainya harus Client ID workspace kunci tersebut.

api_keystringTanpa header Authorization

Kunci API Anda dari halaman yang sama, jika Anda tidak mengirimnya di header. Daftar yang dikembalikan adalah untuk workspace tempat kunci ini dibuat.

Respons#

Request yang berhasil mengembalikan HTTP 200:

{
  "whatsapp_clients": [
    {
      "whatsapp_client_id": 678,
      "whatsapp_number": "919876543210",
      "status": "connected"
    },
    {
      "whatsapp_client_id": 702,
      "whatsapp_number": "919812345678",
      "status": "not_connected"
    }
  ],
  "status": 1
}
FieldTipeDeskripsi
statusinteger1 jika berhasil, 0 jika request gagal.
whatsapp_clientsarraySetiap nomor WhatsApp yang pernah ditambahkan ke workspace ini. Hanya ada jika berhasil.
whatsapp_clients[].whatsapp_client_idintegerID nomor tersebut. Kirim sebagai whatsapp_client di panggilan API lainnya.
whatsapp_clients[].whatsapp_numberstringNomor telepon seperti yang disimpan saat ditambahkan.
whatsapp_clients[].statusstringconnected atau not_connected.

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

Respons yang berhasil tidak memiliki field message, jadi bacalah dengan nilai cadangan (fallback) seperti pada contoh.

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 kunci tersebut ada, belum dihapus, dan milik client_id ini.

Jika server mengalami masalah tak terduga, atau request bukan POST, responsnya berupa objek kosong: {}. Anggap status yang tidak ada sebagai kegagalan.

Tips#

  • Menghubungkan kembali nomor: nomor not_connected dapat dihubungkan kembali di WhatsApp settings atau dengan Hubungkan nomor.
  • Hanya satu nomor: untuk memeriksa satu nomor, gunakan Status koneksi.
  • Beberapa workspace: Kunci API menentukan workspace mana yang ditampilkan. Gunakan kunci yang dibuat di workspace yang Anda inginkan.