REST API dokumentācija

Ārkārtas zvanu REST API

Reģistrējiet numuru un pakalpojuma adresi, sekojiet tā aktivizācijas statusam un atjauniniet ierakstu, mainoties atrašanās vietai.

Atvērt kontam specifisko uzziņu Izstrādātājiem un automatizācijai

Izvēlieties API un akreditācijas datus kopā

Apstiprināti konti kategorijās Izstrādātājiem un automatizācijai, Bizness un Sakaru pakalpojumu sniedzēji var integrēt iespējotus pakalpojumus. Individuālam izstrādātājam nav jāizliekas par uzņēmumu. Lietojumprogrammu SMS/MMS nepieciešams atbilstošs sūtīšanas apstiprinājums un reģistrācija. Pakalpojumam Privātpersonām un ģimenēm nav klientiem pieejama API ziņojumu sūtīšanas sākšanai.

API saime	Bāzes URL	Autentifikācija un rezultāts
Communications v3	`https://api.multitel.net/v3`	Apstiprināti Basic akreditācijas dati; atbilstoši nodrošināti pilnvarojumi tikai darbībām, kas tos atbalsta. JSON `status` un `response`.
Reģistrācija ārkārtas zvanu pakalpojumam	`https://api.multi.tel/emergency`	Apstiprināti Basic akreditācijas dati vai īpaši nodrošināta bearer piekļuve. JSON `code`, `message` un `data`.
Portāla REST integrācijas	Resursdators un darbība ir norādīta jūsu konta izstrādātāju uzziņā	Izmantojiet šīs darbības dokumentētos akreditācijas datus, tvērumus un shēmu. Pārlūkprogrammas sesijas pieprasījumi ir atsevišķa saskarne.

Pirms piemēru izmantošanas iestatiet MULTITEL_API_USERNAME un MULTITEL_API_PASSWORD, izmantojot sava servera slepeno konfigurāciju. Nekad neieguliet tos publiskā pārlūkprogrammas JavaScript kodā, URL vai pirmkoda kontrolē. Speciālie akreditācijas dati tiek pārvaldīti sadaļā API integrācijas iestatījumi.

Nolasiet pārklājumu, nereģistrējot numuru

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

Tiek atbalstīts arī https://api.multitel.net/emergency. Neviens ārkārtas zvanu pakalpojuma bāzes URL nesatur /v3. Pārklājumā ir uzskaitītas starptautiskā pakalpojuma atbalstītās valstis, numuru veidi un cenas; Ziemeļamerikas E911 atbilstība tiek pārbaudīta reģistrācijas laikā.

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

Tas ilustrē tikai aploksni. Katras darbības data shēmu lasiet publicētajā Emergency API ceļvedī.

Reģistrējiet, sekojiet statusam, pēc tam konfigurējiet zvanīšanu

ASV/Kanādai un citiem atbalstītajiem Ziemeļamerikas E911 reģioniem norādiet numuru, E911 adresi un nepieciešamos piekrišanas apstiprinājumus. Ziemeļamerikas E911 ir pieejams tikai produkcijas vidē.
Atbalstītam piederošam starptautiskam numuram norādiet vai nu saglabāta dokumenta (Document) atsauci, vai galalietotāja identitāti un adresi. Vispirms pārskatiet valsts un numura veida prasības.
Nosūtiet vienu POST /registrations pieprasījumu. Neobligāts Idempotency-Key identificē vienu loģisku datu maiņas darbību; atkārtotos mēģinājumos saglabājiet to un tieši tādu pašu pieprasījuma saturu.
Nolasiet GET /registrations/:number. Pārbaudiet dzīves ciklu, pending un actionRequired un veiciet nepieciešamos labojumus. Pieņemšana vai gaidīšana nenozīmē, ka pakalpojums ir aktīvs.
Pēc aktivizēšanas konfigurējiet pareizo ārkārtas zvanītāja ID un valstij specifisko sastādīšanas maršrutu. Izmantojiet pakalpojuma ne-ārkārtas verifikācijas procedūru.

Starptautiskās smilškastes reģistrācijas ir izolētas un neaktivizē īstus ārkārtas zvanus. Ziemeļamerikas E911 nepieciešami galvenā konta akreditācijas dati; ceļvedī ir izskaidrots ierobežotais starptautisko apakškontu atbalsts.

Portāla iestatīšana un verifikācija Valstu pārklājums un ārkārtas numuri Pilns publiskais pieprasījumu, lauku, statusa un atkārtošanas ceļvedis

Apstrādājiet kļūdas un atkārtojumus

Autentifikācijas vai atļaujas kļūme: Pārbaudiet API akreditācijas datu iespējoto stāvokli, atļauto pakalpojumu un avota IP ierobežojumu. Portāla sesijas sīkfails nav integrācijas akreditācijas dati.
Nepietiekams kredīts vai neizpildīts apstiprinājums: Pirms darbības atkārtošanas sakārtojiet konta bilanci, sūtīšanas apstiprinājumu vai dokumentu prasību.
Nav rezultāta: Tukšu krājumu vai trūkstošu zvanītāja vārdu uzskatiet par parastu iznākumu. Nepieņemiet, ka sintaktiski derīgam numuram ir visi pakalpojumi.
Tīkla noildze vai pakalpojuma kļūme: Lasīšanai izmantojiet ierobežotus atkārtojumus ar aizkavi. Pirkumam, sūtīšanai vai reģistrācijai vispirms pārbaudiet darbības stāvokli; pieņemta pieprasījuma atkārtošana var dublēt apmaksājamu darbību.

Idempotences atbalsts ir atkarīgs no API saimes. Emergency API atbalsta atkārtošanas atslēgas; tas nepadara patvaļīgus v3 pieprasījumus par idempotentiem. Atbalstam saglabājiet laikspiedolus, atgrieztos ID un atbildes, no kurām izņemti sensitīvie dati.

Turpiniet ar sava konta atsauci

Pēc pierakstīšanās pieejamā dokumentācija filtrē darbības atbilstoši jūsu atļaujām un iespējotajiem pakalpojumiem. Izmantojiet tajā norādīto precīzo resursdatoru, akreditācijas datu veidu, pieprasījuma laukus un atbildes shēmu. Konsoles var veikt reālas darbības, tostarp pirkumus un ziņojumu sūtīšanu.

Kontam specifisks galapunktu katalogs Komunikāciju REST konsole Publisks komunikāciju OpenAPI dokuments OAuth integrācijas ceļvedis