דלגו לתוכן
Wbiztool

API לחשבונות WhatsApp

ממשק API לסטטוס חיבור WhatsApp

בדקו אם אחד ממספרי ה-WhatsApp שלכם מחובר ומוכן לשליחת הודעות. השתמשו בו לפני קמפיין, או בזמן ההמתנה לסיום הקישור של מספר שחובר זה עתה. השתמשו ב-endpoint הזה ולא ב-/api/v1/whatsapp/status/<id>/, שלא עובד.

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

החליפו את 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 הזה בשבילכם.

Python
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 }
שדהסוגתיאור
statusinteger1 אם המספר מחובר. 0 אם הוא לא מחובר או שהבקשה נכשלה.
messagestringConnected, Disconnected או השגיאה.

גם מספר שמחקתם מהדף הגדרות WhatsApp מחזיר Disconnected.

שגיאות#

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

טיפים#

  • לפני שליחה: אם המספר שממנו אתם שולחים מנותק, ההודעות שלו ממתינות בתור עד שהוא מתחבר מחדש או עד שהן פגות, לכן בדקו את הסטטוס לפני שליחות גדולות. הודעות שלא נשלחו במספר מנותק מוסרות אחרי 90 יום.
  • אחרי חיבור מספר: קראו ל-endpoint הזה כל כמה שניות עד שהוא מחזיר Connected. ה-webhook של connected עשוי להגיע כמה שניות לפני שה-endpoint הזה מחזיר Connected, לכן המשיכו לבדוק עד דקה אחרי האירוע. ראו חיבור מספר.
  • כל המספרים בבת אחת: כדי לקבל את הסטטוס של כל מספר בקריאה אחת, השתמשו ב-רשימת חשבונות.