API לחשבונות WhatsApp
ממשק API לסטטוס חיבור WhatsApp
בדקו אם אחד ממספרי ה-WhatsApp שלכם מחובר ומוכן לשליחת הודעות. השתמשו בו לפני קמפיין, או בזמן ההמתנה לסיום הקישור של מספר שחובר זה עתה. השתמשו ב-endpoint הזה ולא ב-/api/v1/whatsapp/status/<id>/, שלא עובד.
https://wbiztool.com/api/v1/whatsapp-client/status/גוף הבקשה: JSON או שדות טופס
דוגמה מהירה#
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
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp-client/status/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"whatsapp_client": 678,
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400 or 403
if result["status"] == 1:
print("Connected")
elif result["message"] == "Disconnected":
print("Not connected. Reconnect it in WhatsApp settings.")
else:
print("Failed:", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/whatsapp-client/status/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
whatsapp_client: 678,
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403
if (result.status === 1) {
console.log("Connected");
} else if (result.message === "Disconnected") {
console.log("Not connected. Reconnect it in WhatsApp settings.");
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'whatsapp_client' => 678,
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp-client/status/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
if (($result['status'] ?? 0) === 1) {
echo 'Connected';
} elseif (($result['message'] ?? '') === 'Disconnected') {
echo 'Not connected. Reconnect it in WhatsApp settings.';
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}החליפו את 12345, YOUR_API_KEY ו-678 בערכים שלכם. בסעיף אימות מוסבר איפה למצוא אותם.
פרמטרי הבקשה#
client_idintegerחובהמזהה הלקוח שלכם ל-API (API Client ID) מהדף Settings → API keys.
api_keystringחובהמפתח ה-API שלכם מאותו דף.
whatsapp_clientintegerחובההמזהה של מספר ה-WhatsApp לבדיקה, מהדף הגדרות WhatsApp, מ-רשימת חשבונות, או ה-
whatsapp_client_idשהוחזר מ-חיבור מספר.
שימוש בלקוחות הרשמיים#
לקוח ה-Python קורא ל-endpoint הזה בשבילכם.
from wbiztool_client import WbizToolClient
client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)
result = client.get_whatsapp_client_status(678)
print(result)לקוח ה-Python זורק requests.exceptions.HTTPError כשה-API מחזיר HTTP 400 או 403, לכן עטפו את הקריאה ב-try/except.
המתודה getWhatsAppClientStatus() של לקוח ה-Node.js קוראת לכתובת שלא קיימת ונכשלת עם 404. השתמשו ב-fetch כמו בדוגמה המהירה.
תגובה#
כשפרטי ההתחברות שלכם תקינים, הבקשה מחזירה HTTP 200 עם אחד מגופי התגובה הבאים.
המספר מחובר:
{ "message": "Connected", "status": 1 }
המספר לא מחובר:
{ "message": "Disconnected", "status": 0 }
| שדה | סוג | תיאור |
|---|---|---|
status | integer | 1 אם המספר מחובר. 0 אם הוא לא מחובר או שהבקשה נכשלה. |
message | string | Connected, Disconnected או השגיאה. |
גם מספר שמחקתם מהדף הגדרות WhatsApp מחזיר Disconnected.
שגיאות#
| הודעה | HTTP | איך לתקן |
|---|---|---|
Auth Error | 200 | שלחו client_id, api_key ו-whatsapp_client מספרי בגוף בקשת POST, כ-JSON תקין או כשדות טופס. |
Invalid Client Id | 403 | שלחו את client_id כמספר שלם, למשל 12345. |
Auth Error: invalid api key | 400 | ודאו שהמפתח קיים, לא נמחק ושייך ל-client_id הזה. |
Auth Error 2 | 200 | המזהה whatsapp_client הזה לא נמצא בסביבת העבודה של מפתח ה-API. |
Demo Account can not access apis | 200 | השתמשו בחשבון רגיל. |
טיפים#
- לפני שליחה: אם המספר שממנו אתם שולחים מנותק, ההודעות שלו ממתינות בתור עד שהוא מתחבר מחדש או עד שהן פגות, לכן בדקו את הסטטוס לפני שליחות גדולות. הודעות שלא נשלחו במספר מנותק מוסרות אחרי 90 יום.
- אחרי חיבור מספר: קראו ל-endpoint הזה כל כמה שניות עד שהוא מחזיר
Connected. ה-webhook שלconnectedעשוי להגיע כמה שניות לפני שה-endpoint הזה מחזירConnected, לכן המשיכו לבדוק עד דקה אחרי האירוע. ראו חיבור מספר. - כל המספרים בבת אחת: כדי לקבל את הסטטוס של כל מספר בקריאה אחת, השתמשו ב-רשימת חשבונות.
