דלגו לתוכן
WbizTool

API v2 (בטא)

בדיקת מספרים

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

פעולהEndpointהרשאה
התחלת בדיקהPOST /api/v2/number-checkscontacts
רשימת בדיקותGET /api/v2/number-checkscontacts
קבלת בדיקהGET /api/v2/number-checks/{id}contacts
קבלת התוצאותGET /api/v2/number-checks/{id}/resultscontacts

התחלת בדיקה דורשת תוכנית שכוללת אימות מספרים; אחרת התגובה היא 403 plan_required. קריאת בדיקות עובדת בכל תוכנית.

התחלת בדיקה#

POSThttps://wbiztool.com/api/v2/number-checks

גוף הבקשה: JSON (application/json)

המספרים נכנסים לתור, והתגובה היא 201 עם הבדיקה בסטטוס pending. מספר WhatsApp מחובר של סביבת העבודה שלכם בודק אותם בדקות הקרובות. בצעו polling לבדיקה עד ש-status הוא completed, ואז קראו את התוצאות.

גוף הבקשה

numbersarray of stringsחובה

המספרים לבדיקה, 1 עד 10,000 רשומות. כתבו אותם בפורמט בינלאומי עם + (‎+919876543210). מספר בלי קידומת מדינה מקבל את הקידומת של סביבת העבודה. מספרים כפולים נבדקים פעם אחת, ורשומות שאינן מספרי טלפון מדולגות.

namestringאופציונלי

שם לבדיקה, עד 500 תווים, כפי שהוא מוצג בדף אימות מספרים. ברירת המחדל: API check והתאריך והשעה ב-UTC, למשל API check 2026-10-18 10:40.

curl -X POST https://wbiztool.com/api/v2/number-checks \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: october-leads" \
  -d '{
    "name": "October leads",
    "numbers": ["+919876543210", "+447700900123", "+14155550123"]
  }'

תגובה (201):

{
  "id": 51207,
  "name": "October leads",
  "status": "pending",
  "counts": { "total": 3, "pending": 3, "on_whatsapp": 0, "not_on_whatsapp": 0, "cancelled": 0 },
  "created_at": "2026-10-18T10:40:02.511Z",
  "skipped": 0
}

‏skipped הוא מספר הרשומות שלא היו מספר טלפון (טקסט, פחות מ-7 או יותר מ-15 ספרות): הן לא נבדקות ולא נספרות במסגרת התוכנית שלכם.

מגבלות התוכנית#

התוכנית שלכם קובעת כמה מספרים אפשר לבדוק (ראו מגבלות התוכנית):

  • לכל בדיקה: בבדיקה לא יכולים להיות יותר מספרים מהמספר שבתוכנית. מעבר לכך, הבדיקה נדחית עם too_many_numbers, עם count ו-limit.
  • לכל תקופת חיוב: גם כל הבדיקות יחד, מה-API ומלוח הבקרה, לא יכולות לעבור אותו. בדיקה שהייתה עוברת אותו נדחית עם number_check_quota_reached, עם requested, ‏used ו-limit.
  • בתוכנית בלי מגבלה אין אף אחת מהן. ה-API מקבל לכל היותר 10,000 מספרים בבקשה, בכל תוכנית.
  • בדיקה שנדחתה לא מכניסה כלום לתור. פצלו את הרשימה, חכו לתקופה הבאה, או שדרגו.

שגיאות בהתחלת בדיקה#

HTTPקודמתי
400validation_failed‏numbers חסר, ריק או אינו רשימה של מחרוזות, או ש-name ריק או ארוך מדי
403plan_requiredהתוכנית לא כוללת אימות מספרים
422no_valid_numbersאף אחת מהרשומות אינה מספר טלפון; ‏skipped מציין כמה היו
422too_many_numbersיותר מ-10,000 רשומות, או יותר מספרים ממה שהתוכנית מאפשרת לכל בדיקה
422number_check_quota_reachedהבדיקה הייתה עוברת את מספרי התוכנית לתקופת החיוב הזו

רשימת בדיקות#

GEThttps://wbiztool.com/api/v2/number-checks

הבדיקות של סביבת העבודה, מהחדשה לישנה, בדפים (limit מ-1 עד 100, ברירת המחדל 25, ו-cursor), כולל בדיקות שהתחילו בלוח הבקרה. כל אחת מהן היא Number check.

curl https://wbiztool.com/api/v2/number-checks \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

קבלת בדיקה#

GEThttps://wbiztool.com/api/v2/number-checks/{id}

הבדיקה וההתקדמות שלה. בצעו לה polling בערך כל 30 שניות עד ש-status הוא completed.

curl https://wbiztool.com/api/v2/number-checks/51207 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "id": 51207,
  "name": "October leads",
  "status": "processing",
  "counts": { "total": 3, "pending": 1, "on_whatsapp": 1, "not_on_whatsapp": 1, "cancelled": 0 },
  "created_at": "2026-10-18T10:40:02.511Z"
}

בדיקה שלא קיימת מחזירה 404 number_check_not_found.

הבדיקה דורשת מספר WhatsApp של סביבת העבודה שמחובר עם קוד QR או קוד צימוד, והיא ממתינה בזמן שהמספרים שלכם שולחים. בדיקה יכולה להישאר pending או processing לזמן מה; ראו איך הבדיקה עובדת.

קבלת התוצאות#

GEThttps://wbiztool.com/api/v2/number-checks/{id}/results

המספרים של הבדיקה ומה שנמצא, בדפים (limit מ-1 עד 100, ברירת המחדל 25, ו-cursor). אפשר לקרוא אותם בזמן שהבדיקה רצה: מספרים שעדיין לא נבדקו הם pending.

curl "https://wbiztool.com/api/v2/number-checks/51207/results?limit=100" \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "data": [
    { "number": "14155550123", "on_whatsapp": null, "status": "pending", "checked_at": null },
    { "number": "447700900123", "on_whatsapp": false, "status": "not_on_whatsapp", "checked_at": "2026-10-18T10:42:57.204Z" },
    { "number": "919876543210", "on_whatsapp": true, "status": "on_whatsapp", "checked_at": "2026-10-18T10:42:51.880Z" }
  ],
  "next_cursor": null
}
שדהסוגתיאור
numberstringהמספר שנבדק: הספרות שלו עם קידומת המדינה, בלי +.
on_whatsappboolean or null‏true או false אחרי הבדיקה; null כל עוד הוא ממתין או כשהבדיקה שלו בוטלה.
statusstring‏pending, ‏on_whatsapp, ‏not_on_whatsapp או cancelled (נעצר לפני שנבדק).
checked_atstring or nullמתי הוא נבדק.

האובייקט Number check#

שדהסוגתיאור
idintegerהמזהה של הבדיקה.
namestringהשם שלה.
statusstring‏pending (עדיין לא נבדק כלום), processing (חלק נבדקו) או completed (לא נשאר מה לבדוק).
countsobject‏total, ‏pending, ‏on_whatsapp, ‏not_on_whatsapp ו-cancelled.
created_atstringמתי היא התחילה.
skippedintegerרק בתגובה להתחלת בדיקה: רשומות שלא היו מספר טלפון.

מדריכים קשורים#