Перелік типів номерів для реєстрації

Виберіть тип за назвою, повернутою у відповіді

Використовуйте країну з 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"

Параметри шляху
Назва	Тип	Обов’язковий	Опис
`country`	string	Так	Дволітерний код країни за 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: виберіть країну з поточного каталогу реєстрації; це не означає, що документи не потрібні.

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

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