Список шаблонів підтвердних документів

Перегляньте каталог шаблонів

Не вказуйте необов’язковий сегмент шляху 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 на наявність помилок автентифікації або сервісу. Успішна відповідь із порожнім каталогом не є схваленням документа чи звільненням від реєстрації.

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

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