דלגו לתוכן
Wbiztool

API לאימות מספרים

יצירת אימות מספרי WhatsApp (API)

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

POSThttps://wbiztool.com/api/v1/verification/create/

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

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

דוגמה מהירה#

curl -X POST https://wbiztool.com/api/v1/verification/create/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign_name": "Website leads - September",
    "numbers": ["919876543210", "+91 98765 43211", "14155550123"]
  }'

החליפו את YOUR_API_KEY במפתח מהדף Settings → API keys. המפתח קובע לאיזו סביבת עבודה המשימה שייכת.

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

כותרת

Authorizationheaderחובה

Bearer YOUR_API_KEY. המפתח חייב להיות פעיל ולא מחוק. ה-API הזה לא צריך client_id.

Content-Typestringחובה

חייב להיות application/json. עם כל סוג תוכן אחר, numbers לא נקרא ותקבלו Numbers array is required.

גוף הבקשה

numbersarray of stringsחובה

מספרי הטלפון לבדיקה, כל אחד עם קידומת המדינה שלו, למשל 919876543210 למספר הודי. לפני הבדיקה, כל מספר עובר ניקוי:

  • רווחים, +, - וסוגריים מוסרים
  • 0 אחד בתחילת המספר מוסר
  • התוצאה חייבת להכיל ספרות בלבד ולהיות באורך של 10 ספרות לפחות

מספרים שלא עומדים בכך מושמטים בשקט. כפילויות לא מוסרות, כך שכל עותק נבדק בנפרד.

campaign_namestringאופציונלי

שם שלפיו אפשר למצוא את המשימה בלוח הבקרה. אם לא תשלחו אותו, השם יהיה API Verification ואחריו התאריך והשעה של השרת לפי שעון הודו (IST, ‏UTC+5:30), למשל API Verification 20260916_154500. שמות יכולים להיות באורך של עד 500 תווים. אל תשלחו null: שמות ארוכים יותר או null נכשלים עם HTTP 500.

תגובה#

בקשה מוצלחת מחזירה HTTP 200:

{
  "status": "success",
  "message": "Verification task created successfully",
  "campaign_id": 4521,
  "numbers_count": 3,
  "numbers_submitted": ["919876543210", "919876543211", "14155550123"]
}
שדהסוגתיאור
statusstring"success". שגיאות מחזירות "error".
messagestringVerification task created successfully.
campaign_idintegerהמזהה של משימת האימות. השתמשו בו עם סטטוס אימות ועם תוצאות אימות.
numbers_countintegerכמה מספרים התקבלו אחרי הניקוי.
numbers_submittedarray of stringsהמספרים המנוקים שייבדקו. השוו לרשימה ששלחתם כדי לראות אילו מספרים הושמטו.

כל מספר שהתקבל מתחיל במצב pending. המשימה מופיעה גם בדף Number Verification (אימות מספרים) בלוח הבקרה שלכם. הכרטיס שלה שם עשוי להמשיך להציג Processing (בעיבוד) גם אחרי שהיא הסתיימה, לכן השתמשו ב-סטטוס אימות כדי לדעת את המצב האמיתי.

שגיאות#

שגיאות מחזירות גוף JSON עם status שמוגדר ל-"error" וקוד שגיאת HTTP:

{ "status": "error", "message": "No valid phone numbers found" }
HTTPהודעהאיך לתקן
405Only POST method allowedשלחו בקשת POST.
401API key requiredהוסיפו את הכותרת Authorization: Bearer YOUR_API_KEY.
401Invalid API keyודאו שהמפתח קיים ולא נמחק או הושבת.
403Verification feature not available for your planהחבילה שלכם לא כוללת אימות מספרים. שדרגו את החבילה.
400Numbers array is requiredשלחו את numbers כמערך JSON לא ריק, עם Content-Type: application/json.
400No valid phone numbers foundלאף אחד מהמספרים לא היו 10 ספרות או יותר אחרי הניקוי. כללו את קידומת המדינה.
400Request contains N numbers but your plan allows only M verificationsהחבילה שלכם מגבילה את מספר המספרים שבקשה אחת יכולה להכיל. פצלו את הרשימה לבקשות קטנות יותר.
500Internal server error: …בדרך כלל גוף ה-JSON לא תקין, למשל בגלל פסיק מיותר בסוף.

איך המספרים נבדקים#

  1. המשימה נכנסת לתור

    ה-API שומר כל מספר שהתקבל במצב pending ומחזיר תגובה מיד.

  2. מספר WhatsApp מחובר בודק אותם

    המספרים נבדקים עד 10 בכל פעם בעזרת מספר WhatsApp שמחובר בדף הגדרות WhatsApp. כל מספר הופך ל-verified אם הוא רשום ב-WhatsApp, או ל-invalid אם לא. הבדיקות רצות רק במספר מחובר שלא עסוק בשליחת הודעות, כך שבמהלך קמפיין גדול הן עשויות להמתין עד שהשליחה תסתיים.

  3. אתם קוראים את התוצאות

    קראו שוב ושוב ל-סטטוס אימות עד ש-overall_status הוא completed, ואז קראו את המספרים מאותה תגובה או מ-תוצאות אימות.

טיפים#

  • תמיד כללו את קידומת המדינה. מספר מקומי בן 10 ספרות בלי קידומת עובר את בדיקת האורך, אבל הוא נבדק בדיוק כפי שנכתב, כך שהתוצאה לא תהיה עבור המספר שהתכוונתם אליו.
  • אל תשתמשו בקידומת הבינלאומית 00. רק 0 מוביל אחד מוסר, כך ש-00919876543210 נבדק כ-0919876543210. שלחו 919876543210.
  • הסירו כפילויות בעצמכם לפני השליחה, כדי שלא תבזבזו על חזרות את המגבלה לבקשה של החבילה שלכם.
  • בדקו את numbers_submitted כדי למצוא מספרים שהושמטו כי היו קצרים מדי או הכילו אותיות.
  • רשימות גדולות: אם הגעתם למגבלה לבקשה, שלחו כמה משימות קטנות יותר ועקבו אחרי כל campaign_id.

חדשים באימות מספרים? ראו את המדריך לאימות מספרים.