REST API dokumentacija
LRN maršrutizavimo užklausų REST API
Gaukite Šiaurės Amerikos telefono numerio maršrutizavimo numerį ir galimą operatoriaus informaciją už fiksuotą kainą.
Kartu pasirinkite API ir prisijungimo duomenis
Patvirtintos kūrėjų ir automatizavimo, verslo bei ryšių paslaugų teikėjų paskyros gali integruoti įjungtas paslaugas. Individualiam kūrėjui nereikia apsimesti įmone. Programų SMS/MMS siuntimui reikia atitinkamo siuntimo patvirtinimo ir registracijos. Asmeninių ir šeimos poreikių paslauga neturi klientui prieinamos žinučių siuntimo inicijavimo API.
| API šeima | Bazinis URL | Autentifikavimas ir rezultatas |
|---|---|---|
| Ryšių v3 | https://api.multitel.net/v3 | Patvirtinti Basic prisijungimo duomenys; tinkami suteikti prieigos raktai naudojami tik juos palaikančioms operacijoms. JSON status ir response. |
| Registracija skambinimui pagalbos tarnyboms | https://api.multi.tel/emergency | Patvirtinti Basic prisijungimo duomenys arba specialiai suteikta bearer prieiga. JSON code, message ir data. |
| Portalo REST integracijos | Serveris ir operacija nurodyti jūsų paskyros kūrėjų žinyne | Naudokite tos operacijos dokumentacijoje nurodytus prisijungimo duomenis, prieigos apimtis ir schemą. Naršyklės sesijos užklausos yra atskiras prieigos būdas. |
Prieš naudodami pavyzdžius, nustatykite MULTITEL_API_USERNAME ir MULTITEL_API_PASSWORD serverio paslapčių konfigūracijoje. Niekada jų neįtraukite į viešą naršyklės JavaScript kodą, URL adresus ar versijų valdymo sistemą. Specialūs prisijungimo duomenys valdomi skiltyje API integravimo nustatymai.
Atlikite numerio užklausą
GET /v3/lrn/{number} priima paskirties numerį kelyje. Informacijai, priklausančiai nuo skambučio kilmės, galima pateikti pasirenkamą skambinančiojo numerį kaip /v3/lrn/{number}/{ani}. Naudokite Šiaurės Amerikos numerio skaitmenis su šalies kodu, kai jis reikalingas; pavyzdžiuose naudojami rezervuoti išgalvoti numeriai.
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"Užklausa su galiojančiais prisijungimo duomenimis apmokestinama. Tarifas yra 0,00025 USD už užklausą: 0,25 USD už 1 000 arba 250 USD už milijoną. Nuolaidų už didesnį kiekį nėra. Tai maršrutizavimo informacijos užklausa; ji neskambina telefonu.
Perskaitykite rezultatą
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Šis išgalvotas pavyzdys rodo tik atsakymo struktūrą; tai nėra išmatuotas maršrutizavimo rezultatas. Prieš naudodami response, patikrinkite status.code. Laukas cost yra eilutė su valiutos žymeniu pradžioje, o ne JSON skaičius.
| Laukas | Reikšmė |
|---|---|
lrn | Vietos maršrutizavimo numeris (Location Routing Number), naudojamas maršrutizavimo paskirčiai nustatyti. |
ported | Šios užklausos pateikiamas numerio perkėlimo rodiklis: paprastai 0 arba 1. Nenaudokite jo kaip nuosavybės ar tinkamumo paslaugai įrodymo. |
ocn | Operatoriaus numeris (Operating Company Number), kai pateikiamas. |
lata | Vietinės prieigos ir perdavimo zona (Local Access and Transport Area), kai pateikiama. |
rc | Tarifų centras, kai pateikiamas. |
city, state, lec, lectype, jurisdiction, local | Papildoma informacija apie vietą, operatorių ar skambučio kilmę, kai prieinama. Jos gali nebūti arba laukai gali būti tušti. |
Nereikalaukite, kad būtų pateikti visi maršrutizavimo laukai. Nemokamo skambinimo numerių rezultatuose gali nebūti vietinio tarifų centro ir operatoriaus kodo duomenų. Grąžintas LRN negarantuoja pasiekiamumo realiuoju laiku ir nėra skambučio kokybės testas.
Naudokite užklausas savo maršrutizavimo procese
- Prieš siųsdami, patikrinkite užklausoje nurodytą numerį ir suvienodinkite jo formatą.
- Patikrinkite HTTP ir programos būsenas. Trikčių diagnostikai išsaugokite numerio, laiko ir rezultato įrašą su pašalintais neskelbtinais duomenimis.
- Naudokite tik jūsų maršrutizavimo taisyklei reikalingus laukus ir aiškiai numatykite trūkstamų reikšmių tvarkymą.
- Po neaiškaus atsakymo ribokite pakartojimus. Pakartojus užklausą, gali būti pritaikytas dar vienas mokestis; šiam galiniam taškui idempotentiškumo raktas nedokumentuotas.
Žiūrėkite LRN paslaugą ir fiksuotą kainą už užklausą. Viešame OpenAPI kelyje yra ANI segmentas; įdiegta LRN realizacija taip pat priima trumpesnę užklausą be ANI. lrninfo yra atskira operacija ir neturi būti naudojama vietoj šio galinio taško.
Klaidų tvarkymas ir pakartotiniai bandymai
- Autentifikavimo arba leidimų klaida
- Patikrinkite, ar API prisijungimo duomenys aktyvūs, kokia paslauga leidžiama ir koks taikomas šaltinio IP apribojimas. Portalo sesijos slapukas nėra integracijai skirti prisijungimo duomenys.
- Nepakankamas likutis arba trūkstamas patvirtinimas
- Prieš kartodami operaciją, išspręskite paskyros likučio, siuntimo patvirtinimo ar reikalaujamo dokumento klausimą.
- Rezultato nėra
- Tuščią numerių pasiūlą arba nerastą skambintojo vardą laikykite įprastu rezultatu. Nemanykite, kad taisyklingo formato numeriui prieinamos visos paslaugos.
- Tinklo laukimo laikas baigėsi arba paslauga sutriko
- Skaitymo užklausoms taikykite ribotą pakartojimų skaičių su didinamais laukimo tarpais. Pirkdami, siųsdami ar registruodami pirmiausia patikrinkite operacijos būseną; pakartojus jau priimtą užklausą, apmokestinamas veiksmas gali būti atliktas dar kartą.
Idempotentiškumo palaikymas priklauso nuo API šeimos. Pagalbos tarnybų API palaiko pakartojimo raktus; tai nereiškia, kad bet kokia v3 užklausa yra idempotentiška. Pagalbai išsaugokite laiko žymas, grąžintus identifikatorius ir atsakymus su pašalintais neskelbtinais duomenimis.
Tęskite savo paskyros žinyne
Prisijungus rodomas žinynas filtruoja operacijas pagal jūsų teises ir įjungtas paslaugas. Naudokite jame nurodytą tikslų pagrindinį kompiuterį (host), prisijungimo duomenų tipą, užklausos laukus ir atsakymo schemą. Konsolėse galima vykdyti realias operacijas, įskaitant pirkimus ir žinučių siuntimą.