Langkau ke kandungan
Wbiztool

API akaun WhatsApp

API Senarai Nombor WhatsApp Disambungkan

Dapatkan nombor WhatsApp dalam ruang kerja anda yang sedang disambungkan. Gunakannya untuk membolehkan pengguna memilih nombor untuk menghantar, atau untuk mencari ID whatsapp_client bagi panggilan API lain.

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

Body: JSON atau medan borang

Hanya nombor yang disambungkan dipulangkan. Untuk turut melihat nombor yang terputus sambungan, gunakan Senarai akaun.

Contoh ringkas#

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"
  }'

Gantikan 12345 dan YOUR_API_KEY dengan nilai anda sendiri. Lihat Pengesahan identiti untuk mengetahui di mana nilai ini boleh didapati.

Parameter permintaan#

client_idintegerwajib

API Client ID anda dari Settings → API keys (Tetapan → Kunci API).

api_keystringwajib

Kunci API anda dari halaman yang sama. Senarai ini adalah untuk ruang kerja tempat kunci ini dicipta.

Menggunakan klien rasmi#

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 menimbulkan requests.exceptions.HTTPError apabila API memulangkan HTTP 400 atau 403, jadi balut panggilan dalam try/except.

getWhatsAppClients() klien Node.js memanggil alamat yang tidak wujud dan gagal dengan 404. Gunakan fetch seperti dalam Contoh ringkas.

Respons#

Permintaan yang berjaya memulangkan HTTP 200:

{
  "message": "okay",
  "whatsapp_clients": [
    {
      "id": 678,
      "whatsapp_client_id": 678,
      "whatsapp_client_number": "919876543210",
      "is_connected": true
    }
  ],
  "status": 1
}
MedanJenisPenerangan
statusinteger1 jika berjaya, 0 jika permintaan gagal.
messagestringokay jika berjaya, jika tidak, mesej ralat.
whatsapp_clientstatasusunanNombor anda yang disambungkan. Kosong jika tiada yang disambungkan. Hanya ada jika berjaya.
whatsapp_clients[].whatsapp_client_idintegerID nombor. Hantarkannya sebagai whatsapp_client dalam panggilan API lain.
whatsapp_clients[].idintegerNilai yang sama seperti whatsapp_client_id.
whatsapp_clients[].whatsapp_client_numberstringNombor telefon seperti yang disimpan semasa nombor itu ditambah.
whatsapp_clients[].is_connectedbooleanSentiasa true, kerana hanya nombor yang disambungkan disenaraikan.

Susunan senarai tidak dijamin. Isih mengikut whatsapp_client_id jika susunan penting.

Ralat#

MesejHTTPCara membetulkannya
Auth Error200Hantar kedua-dua client_id dan api_key dalam badan POST, sebagai JSON atau medan borang yang sah.
Invalid Client Id403Hantar client_id sebagai nombor bulat, seperti 12345.
Auth Error: invalid api key400Pastikan kunci wujud, belum dipadam dan milik client_id ini.

Permintaan yang bukan POST memulangkan objek kosong {}. Masalah pelayan yang tidak dijangka memulangkan HTTP 500 dengan badan HTML, jadi pastikan respons ialah JSON sebelum membaca status.

Petua#

  • Senarai kosong: "whatsapp_clients": [] bermaksud tiada nombor yang disambungkan dalam ruang kerja ini. Sambung satu nombor di tetapan WhatsApp atau dengan Sambung nombor.
  • Beberapa ruang kerja: kunci API menentukan ruang kerja yang disenaraikan. Gunakan kunci yang dicipta dalam ruang kerja yang anda mahu.
  • Satu nombor sahaja: untuk menyemak satu nombor, gunakan Status sambungan.