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

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

Наличие и побочные эффекты

  • Только поиск. Ничего не резервирует, не заказывает и не изменяет.
  • Результаты отражают наличие на момент запроса и могут меняться между вызовами.