Ознакомьтесь с требованиями к регистрации

Выберите страну и тип номера

Выберите страну регистрации, затем используйте название, возвращённое get_document_number_types. Передайте это название в параметре number_type, а не идентификатор типа или общую категорию поиска номеров.

Ознакомьтесь с полученными инструкциями

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

Не считайте ошибку освобождением от требований

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

Запрос

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

POST с типом содержимого application/json или application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"

Параметры тела запроса
Имя	Тип	Обязательный	Описание
`country`	строка	Да	Код страны по ISO, полученный из get_document_countries.
`number_type`	строка	Да	Название типа из get_document_number_types, например Local; при сопоставлении регистр не учитывается. Укажите название, а не его идентификатор.

Ответ

Проверяйте status.code в теле JSON, а также статус HTTP. response — это один ресурс требований с полями id, type и attributes, а также с полем relationships, если оно возвращается. Идентификаторы в ресурсе и данных связей являются непрозрачными значениями. Из текста необязательного поля restriction_message удаляются теги HTML; обрабатывайте оставшееся содержимое как текст, а не как доверенный HTML. Обработчик возвращает первый ресурс требований, поэтому не считайте этот ответ исчерпывающим списком. Наличие атрибутов и связей зависит от страны и типа; пример не является полной фиксированной схемой.

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

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Ошибки

400: Проверка страны и number_type не пройдена: укажите оба обязательных значения. Текст сообщения о проверке может содержать форматирование.
400: Invalid country ISO or No country registration documents required.: это неоднозначное сообщение само по себе не доказывает освобождение от регистрации.
400: Invalid number type: используйте название типа, полученное в ответе. В устаревшем сообщении об ошибке перечислены Global, Local, Mobile, National, Shared Cost и Toll Free.
500: Unable to load registration requirements for the specified country and number type.: требования не удалось получить. Повторите попытку позже или обратитесь в службу поддержки.

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

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