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

Регистрирайте, следете статуса, после конфигурирайте повикванията

За САЩ/Канада и другите поддържани северноамерикански региони с E911 посочете номера, E911 адреса и необходимите потвърждения за съгласие. Севернoамериканският E911 е достъпен само в реална работна среда.
За поддържан международен номер, който притежавате, предоставете или запазена препратка към документ, или самоличността и адреса на крайния потребител. Първо прегледайте изискванията за държавата и типа номер.
Изпратете една заявка POST /registrations. Незадължителният Idempotency-Key идентифицира логическа промяна; запазете го и точния товар (payload) при повторните опити.
Прочетете GET /registrations/:number. Проверете жизнения цикъл, pending и actionRequired; отстранете необходимите корекции. Приемането или изчакването не означава активна услуга.
След активирането конфигурирайте правилния идентификатор на обаждащия се за спешни повиквания и специфичния за държавата маршрут за набиране. Използвайте процедурата за верификация на услугата, която не е за реално спешно повикване.

Международните регистрации в sandbox са изолирани и не активират реални спешни повиквания. За северноамерикански E911 са необходими идентификационни данни на основния акаунт; ръководството обяснява ограничената поддръжка на международни подакаунти.

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

Обработка на грешки и повторни опити

Грешка при автентикация или разрешения: Проверете дали API идентификационните данни са активирани, дали е разрешена съответната услуга и какво е ограничението за IP адреса на източника. Бисквитката на сесия в портала не е идентификационни данни за интеграция.
Недостатъчен кредит или липсващо одобрение: Уредете баланса по акаунта, одобрението за изпращане или изискването за документи, преди да повторите операцията.
Няма резултат: Третирайте празната наличност или липсващото име на обаждащия се като обичаен резултат. Не приемайте, че синтактично валиден номер разполага с всяка услуга.
Изтичане на времето в мрежата или срив на услугата: За операциите за четене използвайте ограничен брой повторни опити със засилващо се закъснение. При покупка, изпращане или регистрация първо проверете състоянието на операцията; повторението на вече приета заявка може да дублира платено действие.

Поддръжката на идемпотентност зависи от всяко семейство API. API за спешни повиквания поддържа ключове за повторни опити; това не прави произволни заявки към v3 идемпотентни. Запазвайте времевите отпечатъци, върнатите идентификатори и отговорите с премахнати чувствителни данни за поддръжката.

Продължете със справочника на вашия акаунт

Справочникът след вход филтрира операциите според вашите права и активираните услуги. Използвайте точния му хост, типа удостоверяване, полетата на заявката и схемата на отговора. Конзолите могат да изпълняват реални операции, включително покупки и съобщения.

Каталог на крайните точки за вашия акаунт REST конзола за комуникации Публичен OpenAPI документ за комуникациите Ръководство за OAuth интеграция