מפתחים

GET/v3/getcountries

רשימת מדינות עם מספרים במלאי

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

בעמוד זה
  1. בקשה
  2. תגובה
  3. שגיאות
  4. זמינות והשפעות נלוות

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

  • העבירו את isocode אל getareas, אל getstates (עבור US ו־CA בלבד) או אל other.
  • next_function תמיד מפנה אל v3/getareas/{isocode}. עבור ארצות הברית וקנדה, אפשר לקרוא לפונקציה getstates תחילה כדי לצמצם לפי מדינה או פרובינציה.
  • is_mobile ו־sms_coverage הם דגלים ברמת המדינה, ואינם מבטיחים תכונות אלה עבור כל מספר. עבור ארצות הברית, הערך של is_mobile הוא 0 אלא אם בחשבון שלכם מופעלת האפשרות למספרים ניידים בארצות הברית.
  • מדינות שכל הכיסוי בהן זמין בהזמנה בלבד אינן מופיעות ברשימה. עדיין אפשר לקרוא לפונקציה getareas או other ישירות עבור מדינה שאינה מופיעה ברשימה.
  • אם נדרש סדר מסוים, מיינו את הרשימה בעצמכם.

אם אף מדינה אינה עומדת בתנאים, הערך של response הוא null והערך של status.code הוא 200.

בקשה

נדרש: אימות HTTP Basic או אסימון Bearer (ראו אימות ותגובות API). אם האימות נכשל, מוחזרת תגובת HTTP 401 לפני ביצוע החיפוש.

בקשת GET ללא גוף. הפרמטר היחיד הוא pid האופציונלי, שנשלח במחרוזת השאילתה.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
פרמטרים של השאילתה
שםסוגחובהתיאור
pidstringלאפרמטר מתקדם ואופציונלי. מצמצם את הרשימה למדינות המסומנות עבור מקור מלאי אחד. השתמשו רק בערך שסופק על ידי MultiTEL, בצורת מספר או בצורה הקסדצימלית באורך 32 תווים, והשמיטו אותו בשימוש רגיל. pid אינו מצמצם את בדיקת המלאי המתוארת בתגובה. המערכת מתעלמת מערכים לא מוכרים, מאפס ומערכים שנקודת קצה זו אינה מקבלת, ללא שגיאה; במקרה זה הרשימה כוללת את כל המקורות הנתמכים.

תגובה

מעטפת תגובה תקנית. בהצלחה, הערך של status.code הוא 200, הערך של status.msg הוא 'Results: N', הערך של status.results הוא N, ו־response היא רשימת מדינות שסדרן אינו מובטח. שדות: countrycode (קידומת החיוג של המדינה ללא '+'); name (שם המדינה); description (ערך זהה לזה של name); isocode (קוד ISO 3166-1 alpha-2); is_mobile (0 או 1, דגל קטלוג ברמת המדינה, תמיד 0 עבור US אלא אם בחשבון שלכם מופעלת האפשרות למספרים ניידים של US); sms_coverage (0 או 1, דגל קטלוג ברמת המדינה); latitude ו־longitude (קואורדינטות המדינה); next_function ('v3/getareas/{isocode}'). מדינה מופיעה ברשימה רק אם היא גלויה ולפחות לאחת מהקידומות שלה יש כעת מספרים במלאי במקור מלאי כלשהו. מדינות שכל הכיסוי בהן זמין בהזמנה בלבד (ללא מלאי) אינן מופיעות ברשימה. בדיקת מלאי זו רחבה יותר מהמסננים שמפעילה getareas, ולכן קריאה אליה עבור מדינה שמופיעה ברשימה עשויה לעיתים להחזיר 'No areas found'. אם אף מדינה אינה עומדת בתנאים, הערך של status.code הוא 200, הערך של status.msg הוא 'Results: 0', השדה status.results אינו קיים, והערך של response הוא null.

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

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

שגיאות

  • 401: האימות חסר או נכשל. נשלחת עם קוד מצב HTTP 401 (ראו אימות ותגובות API).

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

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