מפתחים

GET/v3/get_document_number_types/{country}

הצגת סוגי מספרים לרישום

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

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

בחרו סוג לפי השם שהוחזר עבורו

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

ספירות קבוצות אינן מלאי מספרים

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

בקשה

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

GET עם כל פרמטר מתועד בנתיב כתובת ה־URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
פרמטרים בנתיב
שםסוגחובהתיאור
countrystringכןקוד מדינה לפי תקן ISO בן שתי אותיות מתוך קטלוג המדינות לרישום. רווחים בתחילתו ובסופו מוסרים והוא מומר לאותיות גדולות.

תגובה

בדקו את status.code בגוף ה־JSON וכן את סטטוס ה־HTTP. response הוא מערך המכיל את id, name ואת available_groups. השתמשו ב־name בתור number_type בעת קריאה ל־get_requirements; אל תשלחו את id במקומו. available_groups הוא מספר רשומות הקבוצות שהוחזרו עבור אותו סוג, ואינו ספירת מלאי של מספרי טלפון או סכום כולל של כל התוצאות בכל הדפים. סוגים שלא הוחזרו עבורם קבוצות אינם נכללים. הסדר המועדף הוא Local, Mobile, National, Toll Free, Shared Cost, Global, ולאחריהם שמות אחרים מהקטלוג.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

שגיאות

  • 400: country is required: ספקו את קוד ה־ISO של המדינה לרישום.
  • 400: Invalid country ISO or no available DID registration country found: בחרו מדינה מתוך קטלוג הרישום הנוכחי; אין בכך כדי לקבוע שלא נדרשים מסמכים.

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

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