Виберіть країну та тип номера
Виберіть країну реєстрації, а потім використайте назву, яку повертає get_document_number_types. Передайте цю назву як number_type, а не ідентифікатор типу чи загальну категорію пошуку номерів.
Прочитайте отримані інструкції
Збережіть ідентифікатори вимоги та зв’язків для відповідного процесу роботи з ідентифікаційними даними й документами. Цей виклик повертає вимоги; він не перевіряє та не подає ваші файли. Дотримуйтеся отриманих інструкцій і всіх вимог, що стосуються вибраного номера.
Не сприймайте помилку як звільнення від реєстрації
Помилка про недійсну країну або відсутність потреби в реєстраційних документах для країни поєднує дві умови. Вона не доводить, що реєстрація не потрібна. Невдалий пошук або порожній результат також не означає схвалення клієнта чи номера. Якщо результат незрозумілий, зверніться до служби підтримки.
Запит
Використовуйте облікові дані свого ввімкненого облікового запису API через HTTPS. Підтримуються базова автентифікація та ввімкнені токени доступу облікового запису API за схемою Bearer; діють обмеження облікового запису.
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.: вимоги не вдалося успішно повернути. Повторіть спробу пізніше або зверніться до служби підтримки.
Доступність і побічні ефекти
- Цей пошук у каталозі та вимогах не створює запису ідентифікаційних даних, не завантажує підтвердного документа, не реєструє номера й не оформлює замовлення.
- Успішна відповідь каталогу не означає схвалення ваших документів або підтвердження того, що вибраний номер можна активувати.