Розробникам

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»).

Наявність і побічні ефекти

  • Лише пошук. Нічого не резервує, не замовляє й не змінює.
  • Результати відображають наявність на момент запиту й можуть змінюватися між викликами.