Dokumentacija REST API-ja
REST API za LRN upit usmjeravanja
Saznajte broj usmjeravanja i dostupne podatke o operateru za sjevernoamerički telefonski broj po fiksnoj cijeni.
Odaberite API i vjerodajnicu zajedno
Odobreni računi s profilima „Razvojni programeri i automatizacija”, „Poslovni” i „Pružatelji komunikacijskih usluga” mogu integrirati omogućene usluge. Pojedinačni programer ne mora se predstavljati kao tvrtka. SMS/MMS iz aplikacija zahtijeva odgovarajuće odobrenje za slanje i registraciju. Usluga „Pojedinci i obitelji” nema korisnicima dostupan API za slanje poruka.
| Obitelj API-ja | Osnovni URL | Autentifikacija i rezultat |
|---|---|---|
| Komunikacije v3 | https://api.multitel.net/v3 | Odobrene Basic vjerodajnice; prikladni dodijeljeni tokeni samo za operacije koje ih podržavaju. JSON status i response. |
| Registracija za hitne pozive | https://api.multi.tel/emergency | Odobrene Basic vjerodajnice ili posebno dodijeljen bearer pristup. JSON code, message i data. |
| REST integracije portala | Host i operacija prikazani u referenci za programere vašeg računa | Koristite dokumentiranu vjerodajnicu, opsege ovlasti i shemu te operacije. Zahtjevi iz sesije preglednika koriste zasebno sučelje. |
Prije korištenja primjera postavite MULTITEL_API_USERNAME i MULTITEL_API_PASSWORD putem konfiguracije tajni na vašem poslužitelju. Nikada ih ne ugrađujte u javni JavaScript preglednika, URL-ove ni upravljanje izvornim kodom. Namjenskim vjerodajnicama upravlja se u postavkama API integracije.
Pretraživanje broja
GET /v3/lrn/{number} prihvaća odredišni broj u putanji. Neobavezni broj pozivatelja može se navesti kao /v3/lrn/{number}/{ani} za podatke ovisne o polazištu. Sjevernoameričke telefonske brojeve navedite samo znamenkama, uz pozivni broj države gdje je primjenjivo; primjeri koriste rezervirane izmišljene brojeve.
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"Izvršavanje pretraživanja s valjanim vjerodajnicama naplaćuje se. Cijena je 0,00025 USD po pretraživanju: 0,25 USD za 1.000 ili 250 USD za milijun. Nema popusta na količinu. Riječ je o pretraživanju podataka o usmjeravanju; ono ne ostvaruje telefonski poziv.
Čitanje rezultata
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Ovaj izmišljeni primjer prikazuje samo oblik odgovora; nije izmjeren rezultat usmjeravanja. Provjerite status.code prije korištenja response. Polje cost je niz znakova s prefiksom valute, a ne JSON broj.
| Polje | Značenje |
|---|---|
lrn | Location Routing Number koji služi za identifikaciju odredišta usmjeravanja. |
ported | Pokazatelj prenosivosti koji daje ovo pretraživanje: obično 0 ili 1. Ne koristite ga kao dokaz vlasništva ili prikladnosti za uslugu. |
ocn | Operating Company Number, kada je naveden. |
lata | Local Access and Transport Area, kada je naveden. |
rc | Rate center, kada je naveden. |
city, state, lec, lectype, jurisdiction, local | Dodatni podaci o lokaciji, operateru ili polazištu, kada su dostupni. Mogu nedostajati ili biti prazni. |
Ne zahtijevajte da su sva polja usmjeravanja prisutna. Rezultati za brojeve s besplatnim pozivima za pozivatelja osobito mogu izostaviti podatke o lokalnom tarifnom području i kodu operatera. Vraćeni LRN nije jamstvo dosegljivosti u stvarnom vremenu niti test kvalitete poziva.
Koristite pretraživanja u svom tijeku usmjeravanja
- Provjerite valjanost i normalizirajte traženi broj prije slanja.
- Provjerite HTTP status i status aplikacije. Za otklanjanje poteškoća čuvajte zapis broja, vremena i rezultata iz kojeg su uklonjeni osjetljivi podaci.
- Koristite samo polja relevantna za vaše pravilo usmjeravanja i izričito obradite nedostajuće vrijednosti.
- Ograničite ponovne pokušaje nakon nejasnog odgovora. Ponavljanje pretraživanja može stvoriti još jednu naplatu; ova krajnja točka nema dokumentiran ključ idempotentnosti.
Pogledajte LRN proizvod i fiksnu cijenu. Javna OpenAPI putanja uključuje ANI segment; implementirani LRN također prihvaća kraći zahtjev bez ANI-ja. lrninfo je zasebna operacija i ne bi se smjela koristiti umjesto ove krajnje točke.
Postupanje s pogreškama i ponovnim pokušajima
- Neuspjela autentifikacija ili dozvola
- Provjerite je li API vjerodajnica omogućena, koja je usluga dopuštena i koja ograničenja vrijede za izvornu IP adresu. Kolačić sesije portala nije vjerodajnica za integraciju.
- Nedovoljno sredstava ili neispunjeno odobrenje
- Riješite stanje računa, odobrenje za slanje ili zahtjev za dokumentom prije ponavljanja operacije.
- Nema rezultata
- Prazan inventar ili nedostajuće ime pozivatelja tretirajte kao uobičajen ishod. Ne pretpostavljajte da sintaktički ispravan broj ima sve usluge.
- Istek vremena čekanja na mreži ili kvar usluge
- Za čitanja koristite ograničen broj ponovnih pokušaja s odgodom (backoff). Za kupnju, slanje ili registraciju najprije provjerite stanje operacije; ponavljanje prihvaćenog zahtjeva može udvostručiti naplativu radnju.
Podrška za idempotentnost ovisi o pojedinoj obitelji API-ja. Emergency API podržava ključeve za ponovne pokušaje; to ne čini proizvoljne v3 zahtjeve idempotentnima. Za podršku sačuvajte vremenske oznake, vraćene ID-ove i odgovore iz kojih su uklonjeni osjetljivi podaci.
Nastavite s referencom za svoj račun
Referenca u koju ste prijavljeni filtrira operacije prema vašim dozvolama i omogućenim uslugama. Koristite njezin točan host, vrstu vjerodajnica, polja zahtjeva i shemu odgovora. Konzole mogu izvršavati operacije uživo, uključujući kupnje i poruke.