Documentație API REST
API REST pentru interogarea rutării LRN
Aflați numărul de rutare și informațiile disponibile despre operator pentru un număr de telefon nord-american, la un preț fix.
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 API | URL de bază | Autentificare și rezultat |
|---|---|---|
| Comunicații v3 | https://api.multitel.net/v3 | Credențiale Basic aprobate; tokenuri provisionate eligibile numai pentru operațiunile care le acceptă. JSON status și response. |
| Înregistrare de urgență | https://api.multi.tel/emergency | Credențiale Basic aprobate sau acces bearer provisionat în mod specific. JSON code, message și data. |
| Integrări REST din portal | Gazda ș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.
Căutați un număr
GET /v3/lrn/{number} acceptă numărul de destinație în cale. Un număr de origine opțional poate fi furnizat ca /v3/lrn/{number}/{ani} pentru informații dependente de origine. Utilizați cifre nord-americane cu codul de țară unde este cazul; exemplele folosesc numere fictive rezervate.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123"curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123/12025550124"Rularea unei căutări cu credențiale valide este facturabilă. Tariful este 0,00025 USD per căutare: 0,25 USD per 1.000 sau 250 USD per milion. Nu există reduceri de volum. Aceasta este o căutare de informații de rutare; nu efectuează un apel telefonic.
Citiți rezultatul
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Acest exemplu inventat demonstrează doar forma răspunsului; nu este un rezultat de rutare măsurat. Verificați status.code înainte de a utiliza response. Câmpul cost este un șir prefixat cu monedă, nu un număr JSON.
| Câmp | Semnificație |
|---|---|
lrn | Numărul de rutare a locației (Location Routing Number) utilizat pentru identificarea destinației de rutare. |
ported | Indicator de portabilitate furnizat de această căutare: de obicei 0 sau 1. Nu îl utilizați ca dovadă a proprietății sau a eligibilității pentru servicii. |
ocn | Numărul companiei operatoare (Operating Company Number), atunci când este furnizat. |
lata | Zona de acces și transport local (Local Access and Transport Area), atunci când este furnizată. |
rc | Centrul tarifar (Rate center), atunci când este furnizat. |
city, state, lec, lectype, jurisdiction, local | Detalii suplimentare despre locație, operator sau origine, atunci când sunt disponibile. Acestea pot lipsi sau pot fi necompletate. |
Nu solicitați ca fiecare câmp de rutare să fie prezent. În special, rezultatele pentru numerele gratuite pot omite detaliile locale privind centrul tarifar și codul operatorului. Un LRN returnat nu este o garanție în timp real a accesibilității și nici un test al calității apelurilor.
Utilizați căutările în fluxul dumneavoastră de rutare
- Validați și normalizați numărul solicitat înainte de a-l trimite.
- Inspectați starea HTTP și starea aplicației. Păstrați o înregistrare cu datele sensibile eliminate a numărului, a orei și a rezultatului pentru depanare.
- Utilizați numai câmpurile relevante pentru regula dumneavoastră de rutare și tratați în mod explicit valorile absente.
- Limitați reîncercările după un răspuns incert. Repetarea unei căutări poate produce o altă taxă; acest endpoint nu are o cheie de idempotență documentată.
Consultați produsul LRN și prețul fix per interogare. Calea publică OpenAPI include un segment ANI; implementarea LRN în funcțiune acceptă și cererea mai scurtă fără ANI. lrninfo este o operațiune separată și nu trebuie folosită în locul acestui endpoint.
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.