Documentație API REST

API-uri REST pentru apeluri de urgență

Înregistrați un număr și o adresă de serviciu, urmăriți starea activării și mențineți înregistrarea la zi pe măsură ce locația se schimbă.

Alegeți împreună API-ul și credențialul

Conturile aprobate pentru Dezvoltatori și automatizare, Companii și Furnizori de comunicații pot integra serviciile activate. Un dezvoltator individual nu trebuie să pretindă că este o companie. SMS/MMS trimise de aplicații necesită aprobarea de trimitere și înregistrarea aplicabile. Serviciul pentru Persoane fizice și familii nu are un API de inițiere a mesajelor accesibil clienților.

Familia APIURL de bazăAutentificare și rezultat
Comunicații v3https://api.multitel.net/v3Credențiale Basic aprobate; tokenuri provisionate eligibile numai pentru operațiunile care le acceptă. JSON status și response.
Înregistrare de urgențăhttps://api.multi.tel/emergencyCredențiale Basic aprobate sau acces bearer provisionat în mod specific. JSON code, message și data.
Integrări REST din portalGazda și operațiunea sunt afișate în referința pentru dezvoltatori a contului dumneavoastrăUtilizați credențialele, domeniile de acces și schema documentate pentru acea operațiune. Cererile din sesiunea browserului reprezintă un canal de acces separat.

Setați MULTITEL_API_USERNAME și MULTITEL_API_PASSWORD prin configurația de secrete a serverului dumneavoastră înainte de a utiliza exemplele. Nu le încorporați niciodată în cod JavaScript public din browser, în URL-uri sau în controlul sursei. Credențialele dedicate sunt gestionate în setările de integrare API.

Citiți acoperirea fără a înregistra un 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 este, de asemenea, acceptat. Niciun URL de bază de urgență nu conține /v3. Acoperirea listează țările internaționale, tipurile de numere acceptate și prețurile; eligibilitatea E911 nord-americană este verificată în timpul înregistrării.

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

Acest exemplu ilustrează doar structura exterioară. Citiți schema data a fiecărei operațiuni în ghidul public al API-ului pentru urgențe.

Înregistrați, urmăriți starea, apoi configurați apelarea

  1. Pentru SUA/Canada și celelalte regiuni E911 nord-americane acceptate, furnizați numărul, adresa E911 și confirmările de consimțământ necesare. E911 nord-american este numai pentru producție.
  2. Pentru un număr internațional deținut acceptat, furnizați fie o referință de document salvată, fie identitatea și adresa utilizatorului final. Verificați mai întâi cerințele privind țara și tipul de număr.
  3. Trimiteți o singură cerere POST /registrations. Un Idempotency-Key opțional identifică o mutație logică; păstrați-l și sarcina utilă exactă la reîncercări.
  4. Citiți GET /registrations/:number. Inspectați ciclul de viață, pending și actionRequired; rezolvați corecțiile necesare. Acceptarea sau starea în așteptare nu înseamnă serviciu activ.
  5. După activare, configurați ID-ul corect de apelant de urgență și ruta de apelare specifică țării. Utilizați procedura de verificare non-urgență a serviciului.

Înregistrările internaționale de test (sandbox) sunt izolate și nu activează apelarea reală de urgență. Credențialele contului principal sunt necesare pentru E911 nord-american; ghidul explică suportul limitat pentru subconturi internaționale.

Gestionați erorile și reîncercările

Eșec de autentificare sau de permisiune
Verificați starea de activare a credențialului API, serviciul permis și restricția de IP sursă. Un cookie de sesiune din portal nu este un credențial de integrare.
Credit insuficient sau aprobare lipsă
Rezolvați soldul contului, aprobarea de trimitere sau cerința privind documentele înainte de a repeta operațiunea.
Niciun rezultat
Tratați inventarul gol sau lipsa numelui apelantului ca pe un rezultat obișnuit. Nu presupuneți că un număr valid din punct de vedere sintactic beneficiază de toate serviciile.
Timeout de rețea sau defecțiune a serviciului
Folosiți reîncercări limitate cu backoff pentru citiri. Pentru o achiziție, trimitere sau înregistrare, inspectați mai întâi starea operațiunii; reîncercarea unei cereri acceptate poate duplica o acțiune facturabilă.

Suportul pentru idempotență aparține fiecărei familii de API. API-ul pentru urgențe acceptă chei de reîncercare; acest lucru nu face ca cererile v3 arbitrare să fie idempotente. Păstrați marcajele de timp, ID-urile returnate și răspunsurile cu datele sensibile eliminate pentru asistență.

Continuați cu referința contului dvs.

Referința accesibilă după autentificare filtrează operațiunile în funcție de permisiunile și serviciile activate ale contului dvs. Folosiți gazda exactă, tipul de credențiale, câmpurile cererii și schema răspunsului indicate acolo. Consolele pot executa operațiuni reale, inclusiv achiziții și mesaje.