REST API документација

REST API-ји за хитне позиве

Региструјте број и адресу услуге, пратите статус активације и одржавајте запис ажурним када се локација мења.

Изаберите API и акредитив заједно

Одобрени налози за програмере и аутоматизацију, пословне кориснике и пружаоце комуникационих услуга могу интегрисати омогућене услуге. Појединачни програмер не мора да се представља као компанија. Апликативни SMS/MMS захтева одговарајуће одобрење за слање и регистрацију. Услуга за појединце и породице нема корисницима доступан API за иницирање слања порука.

Породица API-јаОсновни URLАутентификација и резултат
Комуникације v3https://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 за хитне позиве.

Региструјте, пратите статус, затим подесите позивање

  1. За САД/Канаду и остале подржане северноамеричке E911 регионе наведите број, E911 адресу и потребне потврде сагласности. Северноамерички E911 је само за продукцију.
  2. За подржан међународни број у власништву наведите или сачувану референцу документа или идентитет и адресу крајњег корисника. Прво прегледајте захтеве за државу и тип броја.
  3. Пошаљите један POST /registrations захтев. Опциони Idempotency-Key идентификује једну логичку измену; сачувајте га и тачан садржај захтева при поновним покушајима.
  4. Прочитајте GET /registrations/:number. Проверите животни циклус, pending и actionRequired; решите потребне исправке. Прихватање или стање на чекању није активна услуга.
  5. Након активације подесите исправан ID позиваоца за хитне позиве и путању бирања специфичну за државу. Користите поступак провере услуге који не укључује стварни хитни позив.

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

Обрада грешака и поновних покушаја

Неуспела аутентификација или дозвола
Проверите да ли је API акредитив омогућен, као и дозвољену услугу и ограничење изворне IP адресе. Колачић сесије портала није акредитив за интеграцију.
Недовољно кредита или неиспуњено одобрење
Решите питање стања налога, одобрења за слање или захтева за документацију пре него што поновите операцију.
Нема резултата
Празан инвентар или непостојеће име позиваоца третирајте као уобичајен исход. Не претпостављајте да синтаксно исправан број има све услуге.
Истек мрежне везе или отказивање услуге
За читање користите ограничен број поновних покушаја са повећањем размака (backoff). Код куповине, слања или регистрације прво проверите стање операције; поновно слање прихваћеног захтева може дуплирати наплативу радњу.

Подршка за идемпотентност зависи од сваке породице API-ја. API за хитне позиве подржава кључеве за поновни покушај; то не значи да је произвољан v3 захтев идемпотентан. За подршку сачувајте временске ознаке, враћене ID-јеве и одговоре са уклоњеним осетљивим подацима.

Наставите са референцом вашег налога

Референца за пријављене кориснике филтрира операције према вашим дозволама и омогућеним сервисима. Користите тачан хост, тип креденцијала, поља захтева и шему одговора из ње. Конзоле могу извршавати операције уживо, укључујући куповине и поруке.