קריאת דרישות הרישום

בחירת המדינה וסוג המספר

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

קריאת ההוראות שהוחזרו

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

אין לפרש שגיאה כפטור

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

בקשה

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

POST עם application/json או application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"

תגובה

בדקו את status.code בגוף ה־JSON וגם את סטטוס ה־HTTP. response הוא משאב דרישות יחיד הכולל id, type ו־attributes, וכן relationships כאשר הם מוחזרים. המזהים בנתוני המשאב והקשרים הם אטומים ואין להסיק משמעות מהמבנה שלהם. תגיות HTML מוסרות מהטקסט האופציונלי של restriction_message; יש להתייחס לטקסט שנותר כטקסט, ולא כ־HTML מהימן. רכיב הטיפול מחזיר את משאב הדרישות הראשון, ולכן אין להסיק שתגובה זו היא רשימה ממצה. זמינות המאפיינים והקשרים תלויה במדינה ובסוג; הדוגמה אינה סכמה קבועה ומלאה.

מבנה תגובה להמחשה; אין מדובר בנתוני חשבון בזמן אמת או בהצעת מחיר עדכנית.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

שגיאות

• 400: אימות המדינה ו־number_type נכשל: ספקו את שני ערכי החובה. טקסט האימות עשוי לכלול עיצוב.
• 400: Invalid country ISO or No country registration documents required.: הודעה דו־משמעית זו אינה מוכיחה כשלעצמה שקיים פטור מרישום.
• 400: Invalid number type: השתמשו בשם סוג שהוחזר. הודעת השגיאה הישנה מונה את Global, Local, Mobile, National, Shared Cost ו־Toll Free.
• 500: Unable to load registration requirements for the specified country and number type.: הדרישות לא הוחזרו בהצלחה. נסו שוב מאוחר יותר או פנו לתמיכה.

זמינות והשפעות נלוות

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