Список типов номеров для регистрации

Выберите тип по названию, возвращённому в ответе

Используйте страну из get_document_countries. Передайте полученное название типа в get_requirements. Идентификатор типа в каталоге не является идентификатором префикса, номера или категории подтверждающих документов.

Количество групп не отражает запас доступных номеров

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

Запрос

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

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

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

Ответ

Проверяйте status.code в теле JSON, а также статус HTTP. response — массив, содержащий id, name и available_groups. Используйте name в качестве number_type при вызове get_requirements; не передавайте вместо него id. available_groups — количество записей групп, возвращённых для этого типа, а не количество доступных телефонных номеров или общее количество по всем страницам. Типы, для которых не возвращено ни одной группы, не включаются в ответ. Предпочтительный порядок: Local, Mobile, National, Toll Free, Shared Cost, Global, затем остальные названия из каталога.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Ошибки

• 400: country is required: укажите код ISO страны для регистрации.
• 400: Invalid country ISO or no available DID registration country found: выберите страну из текущего каталога регистрации; эта ошибка не означает, что документы не требуются.

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

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