מפתחים

GET/v3/lnp/project/{uniqueid}/status

בדיקת הסטטוס של פרויקט ניוד

קראו את סיכום הפרויקט ואת הספירות לפי סטטוס בלי לאחזר פרטי הזדהות לחיוב.

בעמוד זה
  1. גישה לחשבון ולפרויקט
  2. בקשה
  3. תגובה
  4. סיכום אינו תוצאה החלה על כל המספרים
  5. פירוש סטטוס הניוד
  6. שגיאות ומגבלות
  7. השפעות

גישה לחשבון ולפרויקט

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

בקשה

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"

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

תגובה

דוגמה לתגובה פיקטיבית.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

השדה החיצוני status.code מדווח על תוצאת ה־API. השדה הנפרד response.status הוא סיכום הניוד המחושב של הפרויקט. אין לבלבל בין השניים.

סיכום אינו תוצאה החלה על כל המספרים

בסיכום נבחר In Progress אם למספר כלשהו יש סטטוס זה; אחרת נבחר Pending, אחרת Completed, ואחרת Rejected. אם אין סטטוס מוכר תואם, ברירת המחדל היא Pending. לכן פרויקט המכיל גם מספרים שהניוד שלהם הושלם וגם מספרים שנדחו מדווח על Completed, אף שעדיין יש בו מספרים שנדחו.

בדקו תמיד את הספירות ואת רשימת המספרים הבודדים לפני שתחליטו שהפרויקט כולו הסתיים. counts.total כולל כל שורה של מספר בפרויקט; המונים האחרים מכסים רק את ארבעת ערכי הסטטוס המוכרים, וסכומם עשוי להיות שונה מהסך הכולל כאשר קיימים ערכים אחרים. פרויקט ללא מספרים מדווח על אפס בכל המונים ועל Pending בסיכום.

פירוש סטטוס הניוד

ערכי הסטטוס המוכרים של מספר
ערךתווית
0Pending
1In Progress
2Completed
9Rejected

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

שגיאות ומגבלות

בדקו הן את תגובת ה־HTTP והן את status.code/status.msg. פרויקט חסר, מחוק או שאינו בבעלות החשבון מחזיר קוד API של 404 עם הודעה שהפרויקט לא נמצא. חלות גם דרישות אימות זהות והגבלות על כתובת הרשת של המקור. הדוגמאות אינן שולחות בקשה חיה, ותגובה מוצלחת אינה הוכחה שמפעיל תקשורת קיבל בקשת ניוד או השלים את הניוד.

השפעות

נקודת קצה זו קוראת ספירות מאוחסנות של הפרויקט. במטפל שנבדק היא אינה מגישה בקשת ניוד, משנה סטטוס, יוזמת שיחה או מחייבת את החשבון. היא אינה מספקת תשאול של מפעיל התקשורת בזמן אמת או הרשמה להתראות באמצעות קריאות חוזרות לאתר.