Langsung ke konten
WbizTool

API Akun WhatsApp

API Daftar nomor WhatsApp terhubung

Dapatkan nomor WhatsApp di workspace Anda yang dapat mengirim saat ini, atau yang pesannya menunggu browser-nya. 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

Nomor yang terhubung dikembalikan, ditambah nomor ekstensi Chrome yang browser-nya tertutup (status waiting_for_browser): Anda dapat mengirim dari nomor tersebut, dan pesannya menunggu sampai browser aktif kembali. Untuk melihat juga nomor yang terputus, gunakan Daftar akun. Akun Telegram yang terhubung juga dicantumkan, dengan platform bernilai telegram.

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#

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.

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",
      "platform": "whatsapp",
      "is_connected": true,
      "status": "connected"
    },
    {
      "id": 702,
      "whatsapp_client_id": 702,
      "whatsapp_client_number": "919812345670",
      "platform": "telegram",
      "is_connected": true,
      "status": "connected"
    },
    {
      "id": 731,
      "whatsapp_client_id": 731,
      "whatsapp_client_number": "919898989898",
      "platform": "whatsapp",
      "is_connected": false,
      "status": "waiting_for_browser"
    }
  ],
  "status": 1
}
FieldTipeDeskripsi
statusinteger1 jika berhasil, 0 jika request gagal.
messagestringokay jika berhasil, selain itu berisi error.
whatsapp_clientsarrayNomor Anda yang terhubung dan nomor ekstensi yang menunggu browser-nya. Kosong jika tidak ada. 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[].platformstringwhatsapp untuk nomor WhatsApp, telegram untuk akun Telegram. Kirim dari keduanya dengan ID-nya sebagai whatsapp_client.
whatsapp_clients[].is_connectedbooleantrue untuk nomor yang terhubung, false untuk nomor ekstensi yang menunggu browser-nya.
whatsapp_clients[].statusstringconnected: nomor mengirim sekarang. waiting_for_browser: nomor ekstensi Chrome yang browser-nya tertutup; pesan yang dikirim dari nomor ini menunggu dan terkirim saat browser aktif kembali, atau kedaluwarsa setelah 48 jam.

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 kunci 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, dan tidak ada nomor ekstensi yang menunggu browser-nya. Hubungkan nomor di WhatsApp settings (pengaturan WhatsApp) atau dengan Hubungkan nomor.
  • Beberapa workspace: Kunci API menentukan workspace mana yang ditampilkan. Gunakan kunci yang dibuat di workspace yang Anda inginkan.
  • Hanya satu nomor: untuk memeriksa satu nomor, gunakan Status koneksi.