דלגו לתוכן
Wbiztool

API לחשבונות WhatsApp

ממשק API לרשימת חשבונות WhatsApp

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

POSThttps://wbiztool.com/api/v1/whatsapp/accounts/

גוף הבקשה: JSON או שדות טופס

הבדלרשימת חשבונותרשימת מספרים מחוברים
כולל מספרים מנותקים ומספרים שנמחקוכןלא
מפתחות הפריטיםwhatsapp_client_id, whatsapp_number, statusid, 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"
  }'

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

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

בתגובה מוצלחת אין שדה message, לכן קראו אותו עם ערך ברירת מחדל, כמו בדוגמאות.

שגיאות#

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

אם השרת נתקל בבעיה לא צפויה, או שהבקשה אינה POST, התגובה היא אובייקט ריק: {}. התייחסו להיעדר status ככישלון.

טיפים#

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