REST API dokumentacija

Skambinimo pagalbos tarnyboms REST API

Užregistruokite numerį ir paslaugos adresą, stebėkite jo aktyvavimo būseną ir atnaujinkite įrašą keičiantis vietai.

Atverti paskyrai skirtą žinyną Kūrėjams ir automatizavimui

Kartu pasirinkite API ir prisijungimo duomenis

Patvirtintos kūrėjų ir automatizavimo, verslo bei ryšių paslaugų teikėjų paskyros gali integruoti įjungtas paslaugas. Individualiam kūrėjui nereikia apsimesti įmone. Programų SMS/MMS siuntimui reikia atitinkamo siuntimo patvirtinimo ir registracijos. Asmeninių ir šeimos poreikių paslauga neturi klientui prieinamos žinučių siuntimo inicijavimo API.

API šeima	Bazinis URL	Autentifikavimas ir rezultatas
Ryšių v3	`https://api.multitel.net/v3`	Patvirtinti Basic prisijungimo duomenys; tinkami suteikti prieigos raktai naudojami tik juos palaikančioms operacijoms. JSON `status` ir `response`.
Registracija skambinimui pagalbos tarnyboms	`https://api.multi.tel/emergency`	Patvirtinti Basic prisijungimo duomenys arba specialiai suteikta bearer prieiga. JSON `code`, `message` ir `data`.
Portalo REST integracijos	Serveris ir operacija nurodyti jūsų paskyros kūrėjų žinyne	Naudokite tos operacijos dokumentacijoje nurodytus prisijungimo duomenis, prieigos apimtis ir schemą. Naršyklės sesijos užklausos yra atskiras prieigos būdas.

Prieš naudodami pavyzdžius, nustatykite MULTITEL_API_USERNAME ir MULTITEL_API_PASSWORD serverio paslapčių konfigūracijoje. Niekada jų neįtraukite į viešą naršyklės JavaScript kodą, URL adresus ar versijų valdymo sistemą. Specialūs prisijungimo duomenys valdomi skiltyje API integravimo nustatymai.

Perskaitykite aprėptį neregistruodami numerio

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

Taip pat palaikomas https://api.multitel.net/emergency. Nė viename pagalbos tarnybų baziniame URL nėra /v3. Aprėptyje išvardytos tarptautinės šalys, palaikomi numerių tipai ir kainos; tinkamumas Šiaurės Amerikos E911 tikrinamas registruojantis.

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

Čia parodyta tik išorinė struktūra. Kiekvienos operacijos data schemą skaitykite viešame pagalbos tarnybų API vadove.

Užregistruokite, stebėkite būseną ir tada konfigūruokite skambinimą

JAV, Kanadai ir kitiems palaikomiems Šiaurės Amerikos E911 regionams pateikite numerį, E911 adresą ir reikalaujamus sutikimo patvirtinimus. Šiaurės Amerikos E911 prieinama tik realaus veikimo aplinkoje.
Palaikomam jums priklausančiam tarptautiniam numeriui pateikite išsaugotą dokumento nuorodą arba galutinio naudotojo tapatybę ir adresą. Pirmiausia peržiūrėkite šalies ir numerio tipo reikalavimus.
Siųskite vieną POST /registrations užklausą. Pasirenkamas Idempotency-Key žymi loginį pakeitimą; pakartotiniams bandymams išlaikykite tą patį raktą ir visiškai tokį patį užklausos turinį.
Perskaitykite GET /registrations/:number. Patikrinkite gyvavimo ciklą, pending ir actionRequired; atlikite reikalaujamus pataisymus. Priėmimas ar laukimo būsena nereiškia aktyvios paslaugos.
Po aktyvavimo sukonfigūruokite tinkamą pagalbos skambučių skambintojo numerį ir šaliai skirtą rinkimo maršrutą. Naudokite paslaugos patikros procedūrą, kuri neskambina pagalbos tarnyboms.

Tarptautinės registracijos bandymų aplinkoje yra izoliuotos ir neįjungia tikrų skambučių pagalbos tarnyboms. Šiaurės Amerikos E911 reikia pagrindinės paskyros prisijungimo duomenų; vadove paaiškintas ribotas tarptautinių antrinių paskyrų palaikymas.

Konfigūravimas ir patikra portale Šalių aprėptis ir pagalbos tarnybų numeriai Išsamus viešų užklausų, laukų, būsenų ir pakartojimų vadovas

Klaidų tvarkymas ir pakartotiniai bandymai

Autentifikavimo arba leidimų klaida: Patikrinkite, ar API prisijungimo duomenys aktyvūs, kokia paslauga leidžiama ir koks taikomas šaltinio IP apribojimas. Portalo sesijos slapukas nėra integracijai skirti prisijungimo duomenys.
Nepakankamas likutis arba trūkstamas patvirtinimas: Prieš kartodami operaciją, išspręskite paskyros likučio, siuntimo patvirtinimo ar reikalaujamo dokumento klausimą.
Rezultato nėra: Tuščią numerių pasiūlą arba nerastą skambintojo vardą laikykite įprastu rezultatu. Nemanykite, kad taisyklingo formato numeriui prieinamos visos paslaugos.
Tinklo laukimo laikas baigėsi arba paslauga sutriko: Skaitymo užklausoms taikykite ribotą pakartojimų skaičių su didinamais laukimo tarpais. Pirkdami, siųsdami ar registruodami pirmiausia patikrinkite operacijos būseną; pakartojus jau priimtą užklausą, apmokestinamas veiksmas gali būti atliktas dar kartą.

Idempotentiškumo palaikymas priklauso nuo API šeimos. Pagalbos tarnybų API palaiko pakartojimo raktus; tai nereiškia, kad bet kokia v3 užklausa yra idempotentiška. Pagalbai išsaugokite laiko žymas, grąžintus identifikatorius ir atsakymus su pašalintais neskelbtinais duomenimis.

Tęskite savo paskyros žinyne

Prisijungus rodomas žinynas filtruoja operacijas pagal jūsų teises ir įjungtas paslaugas. Naudokite jame nurodytą tikslų pagrindinį kompiuterį (host), prisijungimo duomenų tipą, užklausos laukus ir atsakymo schemą. Konsolėse galima vykdyti realias operacijas, įskaitant pirkimus ir žinučių siuntimą.

Paskyrai skirtas galinių taškų katalogas Ryšių REST konsolė Viešas ryšių OpenAPI dokumentas OAuth integravimo vadovas