REST API dokumentatsioon

Hädaabikõnede REST API-d

Registreerige number ja teenuse aadress, jälgige selle aktiveerimise olekut ning hoidke kirje ajakohasena, kui asukoht muutub.

Avage kontospetsiifiline teatmeteave Arendajad ja automatiseerimine

Valige API ja autentimisandmed koos

Profiilide Arendajad ja automatiseerimine, Äri ning Side teenusepakkujad heakskiidetud kontod saavad integreerida lubatud teenuseid. Üksikarendajal ei ole vaja teeselda, et ta on ettevõte. Rakenduse SMS/MMS nõuab asjakohast saatmisluba ja registreerimist. Profiili Eraisikud ja pered teenusel puudub kliendile kättesaadav sõnumite saatmise API.

API-perekond	Baas-URL	Autentimine ja tulemus
Communications v3	`https://api.multitel.net/v3`	Heakskiidetud Basic-autentimisandmed; sobivad väljastatud tokenid ainult toimingute puhul, mis neid toetavad. JSON `status` ja `response`.
Hädaabikõnede registreerimine	`https://api.multi.tel/emergency`	Heakskiidetud Basic-autentimisandmed või spetsiaalselt seadistatud bearer-juurdepääs. JSON `code`, `message` ja `data`.
Portaali REST-integratsioonid	Host ja toiming on näidatud teie konto arendajate teatmeteoses	Kasutage selle toimingu dokumenteeritud autentimisandmeid, õiguste ulatusi ja skeemi. Brauseri seansipäringud kasutavad eraldi liidest.

Seadistage enne näidete kasutamist MULTITEL_API_USERNAME ja MULTITEL_API_PASSWORD oma serveri saladuste konfiguratsiooni kaudu. Ärge kunagi manustage neid avalikku brauseri JavaScripti, URL-idesse ega lähtekoodi haldusse. Eraldi autentimisandmeid hallatakse jaotises API integratsiooni seaded.

Lugege leviala ilma numbrit registreerimata

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 on samuti toetatud. Kumbki hädaabi baas-URL ei sisalda /v3. Katvusloend näitab rahvusvahelise teenuse riike, toetatud numbritüüpe ja hindu; Põhja-Ameerika E911 kasutamise õigust kontrollitakse registreerimise ajal.

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

See illustreerib ainult vastuse välist struktuuri. Lugege iga toimingu data skeemi avaldatud Emergency API juhendist.

Registreerige, jälgige olekut, seejärel seadistage helistamine

USA/Kanada ja teiste toetatud Põhja-Ameerika E911 piirkondade puhul esitage number, E911-aadress ja nõutavad nõusolekukinnitused. Põhja-Ameerika E911 on saadaval ainult päriskeskkonnas.
Teile kuuluva toetatud rahvusvahelise numbri puhul esitage kas salvestatud dokumendi (Document) viide või lõppkasutaja isikuandmed ja aadress. Vaadake esmalt üle riigi ja numbritüübi nõuded.
Saatke üks POST /registrations päring. Valikuline Idempotency-Key tuvastab loogilise muudatuse; säilitage see ja täpne päringu sisu korduskatsete vahel.
Lugege GET /registrations/:number. Kontrollige elutsüklit, pending ja actionRequired; tehke vajalikud parandused. Vastuvõtmine või ootel olek ei ole aktiivne teenus.
Pärast aktiveerimist seadistage õige hädaabi helistaja ID ja riigipõhine valimismarsruut. Kasutage teenuse mittehädaolukorra kontrollimise protseduuri.

Rahvusvahelise testkeskkonna registreeringud on eraldatud ega aktiveeri päris hädaabikõnesid. Põhja-Ameerika E911 jaoks on vaja peakonto autentimisandmeid; juhend selgitab rahvusvaheliste alamkontode piiratud tuge.

Portaali seadistamine ja kinnitamine Riikide leviala ja hädaabinumbrid Täielik avalik päringute, väljade, oleku ja korduskatsete juhend

Vigade ja korduskatsete käsitlemine

Autentimise või loa tõrge: Kontrollige, kas API autentimisandmed on lubatud, millisele teenusele need juurdepääsu annavad ja milline lähte-IP piirang kehtib. Portaali seansiküpsis ei ole integratsiooni autentimisandmed.
Ebapiisav krediit või nõutava heakskiidu puudumine: Enne toimingu kordamist lahendage konto saldo, saatmisloa või dokumendinõudega seotud probleem.
Tulemus puudub: Käsitlege tühja laoseisu või puuduvat helistaja nime tavapärase tulemusena. Ärge eeldage, et süntaktiliselt kehtival numbril on kõik teenused.
Võrgu ajalõpp või teenuse tõrge: Kasutage lugemistoimingute puhul piiratud korduskatseid koos kasvava ooteajaga. Ostu, saatmise või registreerimise puhul kontrollige esmalt toimingu olekut; vastuvõetud päringu kordamine võib arveldatavat toimingut dubleerida.

Idempotentsuse tugi on API-perekonniti erinev. Emergency API toetab korduskatsete võtmeid; see ei muuda suvalisi v3 päringuid idempotentseks. Hoidke toe jaoks alles ajatemplid, tagastatud ID-d ja vastused, millest on tundlikud andmed eemaldatud.

Jätkake oma konto dokumentatsiooniga

Pärast sisselogimist kuvatav dokumentatsioon filtreerib toimingud teie õiguste ja lubatud teenuste järgi. Kasutage selles näidatud täpset hosti, autentimisandmete tüüpi, päringuvälju ja vastuseskeemi. Konsoolid võivad teha tegelikke toiminguid, sealhulgas oste ja sõnumite saatmist.

Kontopõhine lõpp-punktide kataloog Side REST-konsool Side avalik OpenAPI dokument OAuth-i integreerimisjuhend