API לחשבונות WhatsApp
ממשק API לרשימת מספרי WhatsApp מחוברים
קבלו את מספרי ה-WhatsApp בסביבת העבודה שלכם שמחוברים כרגע. השתמשו בו כדי לאפשר למשתמשים לבחור מאיזה מספר לשלוח, או כדי למצוא את מזהה ה-whatsapp_client לקריאות API אחרות.
https://wbiztool.com/api/v1/whatsapp-client/list/גוף הבקשה: JSON או שדות טופס
רק מספרים מחוברים מוחזרים. כדי לראות גם מספרים מנותקים, השתמשו ב-רשימת חשבונות.
דוגמה מהירה#
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"
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp-client/list/",
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 number in result["whatsapp_clients"]:
print(number["whatsapp_client_id"], number["whatsapp_client_number"])
else:
print("Failed:", result.get("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/list/", {
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 number of result.whatsapp_clients) {
console.log(number.whatsapp_client_id, number.whatsapp_client_number);
}
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp-client/list/');
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 $number) {
echo $number['whatsapp_client_id'] . ' ' . $number['whatsapp_client_number'] . PHP_EOL;
}
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}החליפו את 12345 ו-YOUR_API_KEY בערכים שלכם. בסעיף אימות מוסבר איפה למצוא אותם.
פרמטרי הבקשה#
client_idintegerחובהמזהה הלקוח שלכם ל-API (API Client ID) מהדף Settings → API keys.
api_keystringחובהמפתח ה-API שלכם מאותו דף. הרשימה היא של סביבת העבודה שבה נוצר המפתח הזה.
שימוש בלקוחות הרשמיים#
לקוח ה-Python קורא ל-endpoint הזה בשבילכם.
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"])לקוח ה-Python זורק requests.exceptions.HTTPError כשה-API מחזיר HTTP 400 או 403, לכן עטפו את הקריאה ב-try/except.
המתודה getWhatsAppClients() של לקוח ה-Node.js קוראת לכתובת שלא קיימת ונכשלת עם 404. השתמשו ב-fetch כמו בדוגמה המהירה.
תגובה#
בקשה מוצלחת מחזירה HTTP 200:
{
"message": "okay",
"whatsapp_clients": [
{
"id": 678,
"whatsapp_client_id": 678,
"whatsapp_client_number": "919876543210",
"is_connected": true
}
],
"status": 1
}
| שדה | סוג | תיאור |
|---|---|---|
status | integer | 1 בהצלחה, 0 אם הבקשה נכשלה. |
message | string | okay בהצלחה, אחרת השגיאה. |
whatsapp_clients | array | המספרים המחוברים שלכם. ריק אם אין מספר מחובר. מופיע רק בהצלחה. |
whatsapp_clients[].whatsapp_client_id | integer | המזהה של המספר. העבירו אותו בתור whatsapp_client בקריאות API אחרות. |
whatsapp_clients[].id | integer | אותו ערך כמו whatsapp_client_id. |
whatsapp_clients[].whatsapp_client_number | string | מספר הטלפון כפי שנשמר כשהמספר נוסף. |
whatsapp_clients[].is_connected | boolean | תמיד true, כי רק מספרים מחוברים מופיעים ברשימה. |
אין סדר מובטח לרשימה. מיינו לפי whatsapp_client_id אם הסדר חשוב.
שגיאות#
| הודעה | 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 מחזירה אובייקט ריק {}. בעיה לא צפויה בשרת מחזירה HTTP 500 עם גוף HTML, לכן ודאו שהתגובה היא JSON לפני שאתם קוראים את status.
טיפים#
- רשימה ריקה: הערך
"whatsapp_clients": []אומר שאין מספר מחובר בסביבת העבודה הזו. חברו מספר בדף הגדרות WhatsApp או באמצעות חיבור מספר. - כמה סביבות עבודה: מפתח ה-API קובע איזו סביבת עבודה מוצגת ברשימה. השתמשו במפתח שנוצר בסביבת העבודה הרצויה.
- מספר אחד בלבד: כדי לבדוק מספר יחיד, השתמשו ב-סטטוס חיבור.
