Розробникам

GET/v3/countries

Отримати список країн каталогу (застарілий формат)

Застаріла кінцева точка API, що повертає видимі країни, пов’язані з каталогом спеціальних номерів, який використовує GET /v3/other/{isocode}, у тілі відповіді формату {code, data}. Наявність номерів не перевіряється. Використовуйте GET /v3/getcountries, щоб знайти країни з номерами в наявності.

На цій сторінці
  1. Запит
  2. Відповідь
  3. Помилки
  4. Доступність і побічні ефекти

Ця застаріла кінцева точка повертає тіло формату {"code", "data"} замість стандартної оболонки status/response. Вона надає список видимих країн, пов’язаних із каталогом спеціальних номерів, і не перевіряє наявність номерів.

Для нових інтеграцій:

  • Використовуйте GET /v3/getcountries, щоб знайти країни з номерами в наявності.
  • Використовуйте GET /v3/other/{isocode}, щоб дізнатися, які типи спеціальних номерів фактично пропонуються в країні. Навіть для країни з цього списку той запит може повернути порожній каталог.

Запит

Потрібна автентифікація HTTP Basic або токен Bearer (див. «Автентифікація та відповіді API»). Якщо автентифікація не вдалася, до виконання пошуку повертається відповідь HTTP 401 у стандартній оболонці.

GET без параметрів і без тіла запиту.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/countries'

Відповідь

Тіло застарілого формату без стандартної оболонки: {code: 200, data: [...]}. Об’єкт status і поля msg чи results відсутні. Поле data містить список країн, порядок яких не гарантується. Поля: countrycode (телефонний код країни без '+'), name, description (те саме значення, що й у name), isocode, latitude і longitude. Поля is_mobile, sms_coverage чи next_function відсутні. Країна потрапляє до списку, якщо вона видима й пов’язана з каталогом спеціальних номерів. Наявність номерів не перевіряється, тому в країні зі списку наразі може не бути доступних номерів. Якщо жодна країна не відповідає умовам, data має значення null.

Ілюстративний приклад структури відповіді; це не поточні дані облікового запису й не актуальна цінова пропозиція.

{
  "code": 200,
  "data": [
    {
      "countrycode": "33",
      "name": "France",
      "description": "France",
      "isocode": "FR",
      "latitude": "46.0000",
      "longitude": "2.0000"
    }
  ]
}

Помилки

  • 401: Дані автентифікації відсутні або автентифікація не вдалася. Відповідь надсилається з HTTP status 401 у стандартній оболонці status/response, а не в тілі застарілого формату.

Доступність і побічні ефекти

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