API לחשבונות WhatsApp
ממשק API לרשימת חשבונות WhatsApp
השתמשו ב-API הזה כדי לקבל בקריאה אחת רשימה מלאה של כל מספרי ה-WhatsApp שלכם ושל סטטוס החיבור שלהם. בשונה מ-רשימת מספרים מחוברים, הוא כולל גם מספרים מנותקים.
https://wbiztool.com/api/v1/whatsapp/accounts/גוף הבקשה: JSON או שדות טופס
| הבדל | רשימת חשבונות | רשימת מספרים מחוברים |
|---|---|---|
| כולל מספרים מנותקים ומספרים שנמחקו | כן | לא |
| מפתחות הפריטים | whatsapp_client_id, whatsapp_number, status | id, whatsapp_client_id, whatsapp_client_number, is_connected |
message בהצלחה | לא כלול | okay |
דוגמה מהירה#
curl -X POST https://wbiztool.com/api/v1/whatsapp/accounts/ \
-H "Content-Type: application/json" \
-d '{
"client_id": 12345,
"api_key": "YOUR_API_KEY"
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp/accounts/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400 or 403
if result.get("status") == 1:
for account in result["whatsapp_clients"]:
print(account["whatsapp_client_id"], account["whatsapp_number"], account["status"])
else:
print("Failed:", result.get("message", "no response"))// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/whatsapp/accounts/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403
if (result.status === 1) {
for (const account of result.whatsapp_clients) {
console.log(account.whatsapp_client_id, account.whatsapp_number, account.status);
}
} else {
console.error("Failed:", result.message ?? "no response");
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp/accounts/');
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) {
foreach ($result['whatsapp_clients'] as $account) {
echo $account['whatsapp_client_id'] . ' ' . $account['whatsapp_number'] . ' ' . $account['status'] . PHP_EOL;
}
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}החליפו את 12345 ו-YOUR_API_KEY בערכים שלכם. בסעיף אימות מוסבר איפה למצוא אותם.
לאף אחד מהלקוחות הרשמיים אין מתודה ל-endpoint הזה, לכן קראו לו ישירות כמו בדוגמאות.
פרמטרי הבקשה#
client_idintegerחובהמזהה הלקוח שלכם ל-API (API Client ID) מהדף Settings → API keys.
api_keystringחובהמפתח ה-API שלכם מאותו דף. הרשימה היא של סביבת העבודה שבה נוצר המפתח הזה.
תגובה#
בקשה מוצלחת מחזירה 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
}
| שדה | סוג | תיאור |
|---|---|---|
status | integer | 1 בהצלחה, 0 אם הבקשה נכשלה. |
whatsapp_clients | array | כל מספר WhatsApp שנוסף אי פעם לסביבת העבודה הזו. מופיע רק בהצלחה. |
whatsapp_clients[].whatsapp_client_id | integer | המזהה של המספר. העבירו אותו בתור whatsapp_client בקריאות API אחרות. |
whatsapp_clients[].whatsapp_number | string | מספר הטלפון כפי שנשמר כשהוא נוסף. |
whatsapp_clients[].status | string | connected או not_connected. |
הרשימה לא ממוינת בסדר מובטח כלשהו. מיינו לפי whatsapp_client_id אם הסדר חשוב.
בתגובה מוצלחת אין שדה message, לכן קראו אותו עם ערך ברירת מחדל, כמו בדוגמאות.
שגיאות#
| הודעה | HTTP | איך לתקן |
|---|---|---|
Auth Error | 200 | שלחו גם client_id וגם api_key בגוף בקשת POST, כ-JSON תקין או כשדות טופס. |
Invalid Client Id | 403 | שלחו את client_id כמספר שלם, למשל 12345. |
Auth Error: invalid api key | 400 | ודאו שהמפתח קיים, לא נמחק ושייך ל-client_id הזה. |
אם השרת נתקל בבעיה לא צפויה, או שהבקשה אינה POST, התגובה היא אובייקט ריק: {}. התייחסו להיעדר status ככישלון.
טיפים#
- חיבור מחדש של מספר: אפשר לחבר מחדש מספר במצב
not_connectedבדף הגדרות WhatsApp או באמצעות חיבור מספר. - מספר אחד בלבד: כדי לבדוק מספר יחיד, השתמשו ב-סטטוס חיבור.
- כמה סביבות עבודה: מפתח ה-API קובע איזו סביבת עבודה מוצגת ברשימה. השתמשו במפתח שנוצר בסביבת העבודה הרצויה.
