Разработчикам

GET/v3/get_document_countries

Список стран регистрации

Найдите ISO-коды и названия стран, представленных в текущем каталоге регистрации номеров.

На этой странице
  1. Выберите страну регистрации
  2. Если страны нет в списке
  3. Запрос
  4. Ответ
  5. Ошибки
  6. Доступность и побочные эффекты

Выберите страну регистрации

Прежде чем запрашивать типы номеров или требования к регистрации, скопируйте ISO-код страны из этого ответа. Используйте страну предоставления услуги телефонного номера, а не автоматически страну гражданства или адреса клиента.

Если страны нет в списке

Отсутствие страны в списке не доказывает, что документы не требуются или что MultiTEL не может предоставить номер в этой стране. Выбирайте параметры регистрации отдельно от поиска номеров и обратитесь в службу поддержки, если нужная страна недоступна.

Запрос

Используйте учётные данные своей активированной учётной записи API при подключении по HTTPS. Поддерживаются базовая аутентификация и активированные токены доступа типа Bearer для учётной записи API; действуют ограничения учётной записи.

GET с любым документированным параметром в пути URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_countries"

Ответ

Проверяйте status.code в теле JSON, а также статус HTTP. response — массив строк iso и name в верхнем регистре, отсортированный по названию. Этот каталог регистрации отличается от поиска номеров в наличии и от общего списка стран, используемого для адресов. Ответ не гарантирует, что возвращены все страны или все доступные страницы результатов вышестоящего сервиса.

Пример структуры ответа; это не актуальные данные учётной записи и не действующее ценовое предложение.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "iso": "US",
      "name": "United States"
    }
  ]
}

Ошибки

  • 500: Unable to load available registration countries: запрос списка стран регистрации не вернул данных. Повторите попытку позже; не считайте это успешно полученным пустым каталогом.

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

  • Этот запрос каталога или требований не создаёт идентификационную запись, не загружает подтверждающий документ, не регистрирует номер и не оформляет заказ.
  • Успешный ответ с каталогом не означает одобрения ваших документов или подтверждения того, что выбранный номер можно активировать.