דלגו לתוכן
Wbiztool

API לחשבונות WhatsApp

ממשק API לרשימת מספרי WhatsApp מחוברים

קבלו את מספרי ה-WhatsApp בסביבת העבודה שלכם שמחוברים כרגע. השתמשו בו כדי לאפשר למשתמשים לבחור מאיזה מספר לשלוח, או כדי למצוא את מזהה ה-whatsapp_client לקריאות API אחרות.

POSThttps://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"
  }'

החליפו את 12345 ו-YOUR_API_KEY בערכים שלכם. בסעיף אימות מוסבר איפה למצוא אותם.

פרמטרי הבקשה#

client_idintegerחובה

מזהה הלקוח שלכם ל-API (API Client ID) מהדף Settings → API keys.

api_keystringחובה

מפתח ה-API שלכם מאותו דף. הרשימה היא של סביבת העבודה שבה נוצר המפתח הזה.

שימוש בלקוחות הרשמיים#

לקוח ה-Python קורא ל-endpoint הזה בשבילכם.

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"])

לקוח ה-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
}
שדהסוגתיאור
statusinteger1 בהצלחה, 0 אם הבקשה נכשלה.
messagestringokay בהצלחה, אחרת השגיאה.
whatsapp_clientsarrayהמספרים המחוברים שלכם. ריק אם אין מספר מחובר. מופיע רק בהצלחה.
whatsapp_clients[].whatsapp_client_idintegerהמזהה של המספר. העבירו אותו בתור whatsapp_client בקריאות API אחרות.
whatsapp_clients[].idintegerאותו ערך כמו whatsapp_client_id.
whatsapp_clients[].whatsapp_client_numberstringמספר הטלפון כפי שנשמר כשהמספר נוסף.
whatsapp_clients[].is_connectedbooleanתמיד true, כי רק מספרים מחוברים מופיעים ברשימה.

אין סדר מובטח לרשימה. מיינו לפי whatsapp_client_id אם הסדר חשוב.

שגיאות#

הודעהHTTPאיך לתקן
Auth Error200שלחו גם client_id וגם api_key בגוף בקשת POST, כ-JSON תקין או כשדות טופס.
Invalid Client Id403שלחו את client_id כמספר שלם, למשל 12345.
Auth Error: invalid api key400ודאו שהמפתח קיים, לא נמחק ושייך ל-client_id הזה.

בקשה שאינה POST מחזירה אובייקט ריק {}. בעיה לא צפויה בשרת מחזירה HTTP 500 עם גוף HTML, לכן ודאו שהתגובה היא JSON לפני שאתם קוראים את status.

טיפים#

  • רשימה ריקה: הערך "whatsapp_clients": [] אומר שאין מספר מחובר בסביבת העבודה הזו. חברו מספר בדף הגדרות WhatsApp או באמצעות חיבור מספר.
  • כמה סביבות עבודה: מפתח ה-API קובע איזו סביבת עבודה מוצגת ברשימה. השתמשו במפתח שנוצר בסביבת העבודה הרצויה.
  • מספר אחד בלבד: כדי לבדוק מספר יחיד, השתמשו ב-סטטוס חיבור.