Получение списка шаблонов подтверждающих документов

Просмотр каталога шаблонов

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

Выбор шаблона с учётом требований

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

Если шаблоны не возвращены

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

Проверка скачанной копии перед использованием

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

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

Запрос

Используйте учётные данные своей включённой учётной записи 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_supporting_document_templates/$COUNTRY_ISO"

Параметры пути
Имя	Тип	Обязательный	Описание
`iso`	string	Нет	Необязательный фильтр по коду страны ISO. Чтобы получить список без фильтрации, полностью опустите этот сегмент пути. Сравнение выполняется без учёта регистра. При неизвестных значениях или отсутствии совпадений возвращается пустой список, а не явная ошибка неверной страны.

Ответ

Проверяйте status.code в теле JSON, а также статус HTTP. response — массив объектов с полями id, name, permanent, iso и url. Поле permanent имеет тип boolean; поле iso может быть пустым, а его значение могло быть определено по названию шаблона. Рассматривайте сведения о стране как ориентир, а не как решение о допустимости использования. Пустой каталог является успешным ответом 200 и также может возвращаться, когда поиск в вышестоящем сервисе не даёт данных. URL формируется сервисом; имя хоста в нём может отличаться от приведённого в иллюстративном примере.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

Ошибки

Проверяйте status.code и status.msg на наличие ошибок аутентификации или сервиса. Успешный ответ с пустым каталогом не означает одобрения документа или освобождения от регистрации.

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

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