Списък с шаблони за подкрепящи документи

Разгледайте каталога с шаблони

Пропуснете незадължителния 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 за грешки при удостоверяване или грешки в услугата. Успешният отговор с празен каталог не представлява одобрение на документ или освобождаване от изискване за регистрация.

Наличност и странични ефекти

Тази справка в каталога или изискванията не създава самоличност, не качва удостоверителен документ, не регистрира номер и не прави поръчка.
Успешният отговор от каталога не представлява одобрение на вашите документи или потвърждение, че избран номер може да бъде активиран.