Langkau ke kandungan
Wbiztool

API akaun WhatsApp

API Status Sambungan WhatsApp

Semak sama ada salah satu nombor WhatsApp anda disambungkan dan sedia untuk menghantar mesej. Gunakannya sebelum kempen, atau semasa menunggu nombor yang baru disambungkan selesai dipautkan. Gunakan endpoint ini dan bukannya /api/v1/whatsapp/status/<id>/, yang tidak berfungsi.

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

Body: JSON atau medan borang

Contoh ringkas#

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

Gantikan 12345, YOUR_API_KEY dan 678 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.

whatsapp_clientintegerwajib

ID nombor WhatsApp yang hendak disemak, dari tetapan WhatsApp, Senarai akaun atau whatsapp_client_id yang dipulangkan oleh Sambung nombor.

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.get_whatsapp_client_status(678)
print(result)

Klien Python menimbulkan requests.exceptions.HTTPError apabila API memulangkan HTTP 400 atau 403, jadi balut panggilan dalam try/except.

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

Respons#

Permintaan memulangkan HTTP 200 dengan salah satu badan berikut apabila kelayakan anda sah.

Nombor disambungkan:

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

Nombor tidak disambungkan:

{ "message": "Disconnected", "status": 0 }
MedanJenisPenerangan
statusinteger1 jika nombor disambungkan. 0 jika ia tidak disambungkan atau permintaan gagal.
messagestringConnected, Disconnected, atau mesej ralat.

Nombor yang telah anda padam dari tetapan WhatsApp juga memulangkan Disconnected.

Ralat#

MesejHTTPCara membetulkannya
Auth Error200Hantar client_id, api_key dan whatsapp_client berangka 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.
Auth Error 2200ID whatsapp_client itu tiada dalam ruang kerja kunci API ini.
Demo Account can not access apis200Gunakan akaun biasa.

Petua#

  • Sebelum menghantar: jika nombor yang digunakan untuk menghantar terputus sambungan, mesejnya menunggu dalam baris gilir sehingga nombor itu disambungkan semula atau mesej tamat tempoh, jadi semak status sebelum penghantaran besar. Mesej yang belum dihantar pada nombor yang terputus sambungan akan dibuang selepas 90 hari.
  • Selepas menyambung nombor: tinjau endpoint ini setiap beberapa saat sehingga ia memulangkan Connected. Webhook connected boleh tiba beberapa saat sebelum endpoint ini memulangkan Connected, jadi teruskan meninjau sehingga satu minit selepas peristiwa itu. Lihat Sambung nombor.
  • Semua nombor sekali gus: untuk mendapatkan status setiap nombor dalam satu panggilan, gunakan Senarai akaun.