Документація REST API

REST API екстрених викликів

Зареєструйте номер і адресу надання послуги, стежте за станом активації та підтримуйте запис в актуальному стані, коли місцезнаходження змінюється.

Відкрити довідник для вашого облікового запису Розробники й автоматизація

Обирайте API та облікові дані разом

Схвалені облікові записи з профілями «Розробники й автоматизація», «Бізнес» і «Постачальники комунікаційних послуг» можуть інтегрувати ввімкнені послуги. Індивідуальному розробникові не потрібно видавати себе за компанію. Для SMS/MMS із застосунків потрібні відповідне погодження надсилання та реєстрація. Послуга «Для приватних осіб і сімей» не має доступного клієнтам API для надсилання повідомлень.

Сімейство API	Базова URL-адреса	Автентифікація та результат
Комунікації v3	`https://api.multitel.net/v3`	Схвалені облікові дані Basic; придатні надані токени лише для операцій, які їх підтримують. JSON `status` і `response`.
Реєстрація екстрених викликів	`https://api.multi.tel/emergency`	Схвалені облікові дані Basic або спеціально наданий доступ за bearer-токеном. JSON `code`, `message` і `data`.
REST-інтеграції порталу	Хост і операція, указані в довіднику розробника вашого облікового запису	Використовуйте задокументовані для цієї операції облікові дані, області доступу та схему. Запити із сеансу браузера використовують окремий інтерфейс.

Перш ніж використовувати приклади, задайте MULTITEL_API_USERNAME і MULTITEL_API_PASSWORD через конфігурацію секретів вашого сервера. Ніколи не вбудовуйте їх у публічний JavaScript для браузера, URL-адреси чи систему контролю версій. Окремими обліковими даними можна керувати в розділі налаштувань інтеграції API.

Читання покриття без реєстрації номера

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

https://api.multitel.net/emergency також підтримується. Жодна з базових URL-адрес екстрених викликів не містить /v3. Покриття перелічує міжнародні країни, підтримувані типи номерів і ціни; право на північноамериканський E911 перевіряється під час реєстрації.

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

Це ілюструє лише конверт. Схему data кожної операції дивіться в опублікованому посібнику Emergency API.

Зареєструйте, стежте за статусом, а потім налаштуйте виклики

Для США/Канади та інших підтримуваних регіонів північноамериканського E911 вкажіть номер, адресу E911 і потрібні підтвердження згоди. Північноамериканський E911 доступний лише в робочому середовищі.
Для підтримуваного власного міжнародного номера вкажіть або збережене посилання на Document, або особисті дані та адресу кінцевого користувача. Спершу ознайомтеся з вимогами для країни й типу номера.
Надішліть один запит POST /registrations. Необов’язковий Idempotency-Key ідентифікує логічну зміну; зберігайте його та точне корисне навантаження під час повторних спроб.
Прочитайте GET /registrations/:number. Перевіряйте життєвий цикл, pending і actionRequired; вносьте необхідні виправлення. Прийняття або очікування — це ще не активна послуга.
Після активації налаштуйте правильний ідентифікатор абонента для екстрених викликів і маршрут набору, специфічний для країни. Використовуйте процедуру верифікації служби без екстреного виклику.

Реєстрації в міжнародній пісочниці ізольовані й не активують справжні екстрені виклики. Для північноамериканського E911 потрібні облікові дані основного облікового запису; посібник пояснює обмежену підтримку міжнародних підоблікових записів.

Налаштування та верифікація в порталі Покриття за країнами та номери екстрених служб Повний публічний посібник із запитів, полів, статусу та повторних спроб

Обробка помилок і повторних спроб

Збій автентифікації або дозволів: Перевірте, чи ввімкнено облікові дані API, яку послугу дозволено та які обмеження діють для IP-адреси джерела. Cookie сеансу порталу не є обліковими даними для інтеграції.
Недостатньо коштів або невиконане погодження: Перш ніж повторювати операцію, усуньте проблему з балансом рахунку, погодженням надсилання або вимогою щодо документів.
Немає результату: Сприймайте порожній перелік номерів або відсутнє ім’я абонента як звичайний результат. Не припускайте, що синтаксично коректний номер має всі служби.
Тайм-аут мережі або збій служби: Для читання використовуйте обмежену кількість повторних спроб із затримкою, що зростає. Для купівлі, надсилання або реєстрації спершу перевірте стан операції: повторення прийнятого запиту може продублювати платну дію.

Підтримка ідемпотентності залежить від сімейства API. Emergency API підтримує ключі повторних спроб, але це не робить довільні запити v3 ідемпотентними. Зберігайте для служби підтримки часові позначки, повернуті ідентифікатори та відповіді, з яких вилучено конфіденційні дані.

Продовжте з довідником вашого облікового запису

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

Каталог кінцевих точок для вашого облікового запису Консоль Communications REST Публічний документ OpenAPI для комунікацій Посібник з інтеграції OAuth