Dokumentacioni i REST API

API REST për thirrjet e urgjencës

Regjistroni një numër dhe adresën e shërbimit, ndiqni statusin e aktivizimit të tij dhe mbajeni regjistrimin të përditësuar kur ndryshon vendndodhja.

Hapni referencën specifike të llogarisë Zhvillues dhe automatizim

Zgjidhni API-në dhe kredencialin së bashku

Llogaritë e miratuara të kategorive Zhvillues dhe automatizim, Biznes dhe Ofrues të komunikimeve mund të integrojnë shërbimet e aktivizuara. Një zhvillues individual nuk ka nevojë të hiqet si kompani. SMS/MMS e aplikacionit kërkon miratimin dhe regjistrimin përkatës të dërgimit. Shërbimi Individë dhe familje nuk ka API të aksesueshme nga klienti për të nisur dërgimin e mesazheve.

Familja API	URL bazë	Vërtetimi dhe rezultati
Communications v3	`https://api.multitel.net/v3`	Kredenciale Basic të miratuara; tokenë të siguruar të pranueshëm vetëm për operacionet që i mbështesin. JSON `status` dhe `response`.
Regjistrimi për shërbimin e thirrjeve të emergjencës	`https://api.multi.tel/emergency`	Kredenciale Basic të miratuara ose akses bearer i siguruar posaçërisht. JSON `code`, `message` dhe `data`.
Integrimet REST të portalit	Hosti dhe operacioni tregohen në referencën e zhvilluesit të llogarisë suaj	Përdorni kredencialin, fushëveprimin e lejeve dhe skemën e dokumentuar të atij operacioni. Kërkesat e sesionit të shfletuesit përdorin një ndërfaqe të veçantë.

Vendosni MULTITEL_API_USERNAME dhe MULTITEL_API_PASSWORD përmes konfigurimit sekret të serverit tuaj përpara se të përdorni shembujt. Mos i ngulitni kurrë në JavaScript publik të shfletuesit, në URL ose në kontrollin e burimit. Kredencialet e dedikuara menaxhohen te Cilësimet e Integrimit API.

Lexoni mbulimin pa regjistruar një numër

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 mbështetet gjithashtu. Asnjëra URL bazë e emergjencës nuk përmban /v3. Mbulimi liston shtetet e mbështetura nga shërbimi ndërkombëtar, llojet e mbështetura të numrave dhe çmimet; pranueshmëria E911 e Amerikës së Veriut kontrollohet gjatë regjistrimit.

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

Kjo ilustron vetëm mbështjellësen. Lexoni skemën data të secilit operacion në udhëzuesin e publikuar të Emergency API.

Regjistrohuni, ndiqni statusin, pastaj konfiguroni telefonimin

Për SHBA/Kanada dhe rajonet e tjera të mbështetura E911 të Amerikës së Veriut, jepni numrin, adresën E911 dhe konfirmimet e kërkuara të pëlqimit. E911 i Amerikës së Veriut është vetëm për mjedisin e përdorimit real.
Për një numër ndërkombëtar të mbështetur në pronësi, jepni ose një referencë të ruajtur Document ose identitetin dhe adresën e përdoruesit fundor. Rishikoni fillimisht kërkesat e shtetit dhe të llojit të numrit.
Dërgoni një kërkesë POST /registrations. Një Idempotency-Key opsional identifikon një mutacion logjik; ruajeni atë dhe ngarkesën e saktë gjatë riprovave.
Lexoni GET /registrations/:number. Inspektoni ciklin jetësor, pending dhe actionRequired; zgjidhni korrigjimet e kërkuara. Pranimi ose pritja nuk është shërbim aktiv.
Pas aktivizimit, konfiguroni ID-në e saktë të telefonuesit të emergjencës dhe rrugën e thirrjes specifike për shtetin. Përdorni procedurën e verifikimit jo-emergjent të shërbimit.

Regjistrimet ndërkombëtare sandbox janë të izoluara dhe nuk aktivizojnë telefonimin e vërtetë të emergjencës. Kredencialet e llogarisë kryesore kërkohen për E911 të Amerikës së Veriut; udhëzuesi shpjegon mbështetjen e kufizuar ndërkombëtare të nënllogarive.

Konfigurimi dhe verifikimi në portal Mbulimi sipas shtetit dhe numrat e emergjencës Udhëzues i plotë publik për kërkesat, fushat, statusin dhe riprovat

Trajtoni gabimet dhe riprovat

Dështim vërtetimi ose lejimi: Kontrolloni gjendjen e aktivizimit të kredencialit API, shërbimin e lejuar dhe kufizimin e IP-së burim. Një cookie sesioni portali nuk është kredencial integrimi.
Kredi e pamjaftueshme ose miratim i paplotësuar: Zgjidhni problemin me bilancin e llogarisë, miratimin e dërgimit ose kërkesën për dokumente përpara se të përsërisni operacionin.
Asnjë rezultat: Trajtojeni inventarin bosh ose mungesën e emrit të telefonuesit si një rezultat të zakonshëm. Mos supozoni se një numër sintaksisht i vlefshëm i ka të gjitha shërbimet.
Skadim kohe i rrjetit ose dështim shërbimi: Përdorni riprova të kufizuara me pritje rritëse për leximet. Për një blerje, dërgim ose regjistrim, inspektoni fillimisht gjendjen e operacionit; riprovimi i një kërkese të pranuar mund të dyfishojë një veprim të faturueshëm.

Mbështetja e idempotencës i përket secilës familje API. Emergency API mbështet çelësat e riprovës; kjo nuk i bën kërkesat arbitrare v3 idempotente. Mbani vulat kohore, ID-të e kthyera dhe përgjigjet me të dhënat e ndjeshme të hequra për mbështetjen.

Vazhdoni me referencën e llogarisë suaj

Referenca pas hyrjes në llogari i filtron operacionet sipas lejeve tuaja dhe shërbimeve të aktivizuara. Përdorni hostin e saktë, llojin e kredencialeve, fushat e kërkesës dhe skemën e përgjigjes që tregon ajo. Konsolat mund të ekzekutojnë operacione reale, përfshirë blerje dhe mesazhe.

Katalogu i endpoint-eve specifik për llogarinë Konsola REST e komunikimeve Dokumenti publik OpenAPI i komunikimeve Udhëzuesi i integrimit OAuth