REST API dokumentatsioon
LRN-i marsruutimispäringu REST API
Leidke Põhja-Ameerika telefoninumbri marsruutimisnumber ja saadaolev operaatoriteave ühtse hinnaga päringu kohta.
Valige API ja autentimisandmed koos
Profiilide Arendajad ja automatiseerimine, Äri ning Side teenusepakkujad heakskiidetud kontod saavad integreerida lubatud teenuseid. Üksikarendajal ei ole vaja teeselda, et ta on ettevõte. Rakenduse SMS/MMS nõuab asjakohast saatmisluba ja registreerimist. Profiili Eraisikud ja pered teenusel puudub kliendile kättesaadav sõnumite saatmise API.
| API-perekond | Baas-URL | Autentimine ja tulemus |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Heakskiidetud Basic-autentimisandmed; sobivad väljastatud tokenid ainult toimingute puhul, mis neid toetavad. JSON status ja response. |
| Hädaabikõnede registreerimine | https://api.multi.tel/emergency | Heakskiidetud Basic-autentimisandmed või spetsiaalselt seadistatud bearer-juurdepääs. JSON code, message ja data. |
| Portaali REST-integratsioonid | Host ja toiming on näidatud teie konto arendajate teatmeteoses | Kasutage selle toimingu dokumenteeritud autentimisandmeid, õiguste ulatusi ja skeemi. Brauseri seansipäringud kasutavad eraldi liidest. |
Seadistage enne näidete kasutamist MULTITEL_API_USERNAME ja MULTITEL_API_PASSWORD oma serveri saladuste konfiguratsiooni kaudu. Ärge kunagi manustage neid avalikku brauseri JavaScripti, URL-idesse ega lähtekoodi haldusse. Eraldi autentimisandmeid hallatakse jaotises API integratsiooni seaded.
Otsige numbrit
GET /v3/lrn/{number} võtab teekonnas vastu sihtnumbri. Lähtekohast sõltuva teabe saamiseks saab valikulise helistaja numbri esitada kujul /v3/lrn/{number}/{ani}. Kasutage Põhja-Ameerika telefoninumbreid ainult numbritena, vajaduse korral koos riigikoodiga; näidetes kasutatakse reserveeritud väljamõeldud numbreid.
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"Kehtivate autentimisandmetega otsingu käivitamine on tasuline. Tariif on 0,00025 $ otsingu kohta: 0,25 $ 1000 kohta või 250 $ miljoni kohta. Mahuallahindlused puuduvad. See on marsruutimisteabe otsing; see ei tee telefonikõnet.
Lugege tulemust
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}See väljamõeldud näide näitab ainult vastuse struktuuri; see ei ole mõõdetud marsruutimistulemus. Kontrollige status.code enne response kasutamist. Väli cost on valuuta eesliitega string, mitte JSON-number.
| Väli | Tähendus |
|---|---|
lrn | Asukoha marsruutimisnumber (Location Routing Number), mida kasutatakse marsruutimise sihtkoha tuvastamiseks. |
ported | Selle päringu tagastatud numbri teisaldamise näitaja: tavaliselt 0 või 1. Ärge kasutage seda omandiõiguse ega teenuse kasutamise õiguse tõendina. |
ocn | Teenust osutava ettevõtte number (Operating Company Number), kui see on esitatud. |
lata | Kohaliku juurdepääsu ja transpordi piirkond (Local Access and Transport Area), kui see on esitatud. |
rc | Tariifikeskus (rate center), kui see on esitatud. |
city, state, lec, lectype, jurisdiction, local | Täiendavad asukoha, operaatori või päritoluga seotud üksikasjad, kui need on saadaval. Need võivad puududa või olla tühjad. |
Ärge nõudke iga marsruutimisvälja olemasolu. Eelkõige võivad helistajale tasuta numbrite tulemused jätta välja kohaliku tariifikeskuse ja operaatorikoodi üksikasjad. Tagastatud LRN ei ole reaalajas kättesaadavuse garantii ega kõnekvaliteedi test.
Kasutage otsinguid oma marsruutimise töövoos
- Kontrollige ja normaliseerige taotletud number enne selle saatmist.
- Kontrollige HTTP- ja rakenduse olekut. Hoidke tõrkeotsinguks alles kirje numbrist, ajast ja tulemusest, eemaldades sellest tundlikud andmed.
- Kasutage ainult teie marsruutimisreegli jaoks asjakohaseid välju ja käsitlege puuduvaid väärtusi selgesõnaliselt.
- Piirake korduskatseid pärast ebakindlat vastust. Otsingu kordamine võib kaasa tuua uue tasu; sellel lõpp-punktil puudub dokumenteeritud idempotentsusvõti.
Vaadake LRN-toodet ja ühtset hinda päringu kohta. Avalik OpenAPI tee sisaldab ANI segmenti; juurutatud LRN-rakendus aktsepteerib ka lühemat päringut ilma ANI-ta. lrninfo on eraldi toiming ja seda ei tohi kasutada selle lõpp-punkti asemel.
Vigade ja korduskatsete käsitlemine
- Autentimise või loa tõrge
- Kontrollige, kas API autentimisandmed on lubatud, millisele teenusele need juurdepääsu annavad ja milline lähte-IP piirang kehtib. Portaali seansiküpsis ei ole integratsiooni autentimisandmed.
- Ebapiisav krediit või nõutava heakskiidu puudumine
- Enne toimingu kordamist lahendage konto saldo, saatmisloa või dokumendinõudega seotud probleem.
- Tulemus puudub
- Käsitlege tühja laoseisu või puuduvat helistaja nime tavapärase tulemusena. Ärge eeldage, et süntaktiliselt kehtival numbril on kõik teenused.
- Võrgu ajalõpp või teenuse tõrge
- Kasutage lugemistoimingute puhul piiratud korduskatseid koos kasvava ooteajaga. Ostu, saatmise või registreerimise puhul kontrollige esmalt toimingu olekut; vastuvõetud päringu kordamine võib arveldatavat toimingut dubleerida.
Idempotentsuse tugi on API-perekonniti erinev. Emergency API toetab korduskatsete võtmeid; see ei muuda suvalisi v3 päringuid idempotentseks. Hoidke toe jaoks alles ajatemplid, tagastatud ID-d ja vastused, millest on tundlikud andmed eemaldatud.
Jätkake oma konto dokumentatsiooniga
Pärast sisselogimist kuvatav dokumentatsioon filtreerib toimingud teie õiguste ja lubatud teenuste järgi. Kasutage selles näidatud täpset hosti, autentimisandmete tüüpi, päringuvälju ja vastuseskeemi. Konsoolid võivad teha tegelikke toiminguid, sealhulgas oste ja sõnumite saatmist.