REST API-dokumentasie
LRN-roeteringsopsoek-REST-API
Soek die roeteringsnommer en beskikbare diensverskafferinligting vir 'n Noord-Amerikaanse telefoonnommer teen 'n vaste prys per opsoek op.
Kies die API en aanmeldbesonderhede saam
Goedgekeurde rekeninge vir Ontwikkelaar en Outomatisering, Besigheid en Kommunikasieverskaffers kan geaktiveerde dienste integreer. 'n Individuele ontwikkelaar hoef nie voor te gee om 'n maatskappy te wees nie. SMS/MMS vanaf toepassings vereis die toepaslike versendingsgoedkeuring en registrasie. Die diens vir Individue en gesinne het geen API wat kliënte kan gebruik om boodskappe te stuur nie.
| API-familie | Basis-URL | Stawing en resultaat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Goedgekeurde Basic-aanmeldbesonderhede; toepaslike uitgereikte tokens slegs vir bewerkings wat dit ondersteun. JSON status en response. |
| Registrasie vir noodoproepe | https://api.multi.tel/emergency | Goedgekeurde Basic-aanmeldbesonderhede of spesifiek geaktiveerde bearer-toegang. JSON code, message en data. |
| Portaal-REST-integrasies | Gasheer en bewerking word in jou rekening se ontwikkelaarverwysing getoon | Gebruik daardie bewerking se gedokumenteerde aanmeldbesonderhede, toestemmingsomvang en skema. Blaaier-sessieversoeke gebruik 'n afsonderlike koppelvlak. |
Stel MULTITEL_API_USERNAME en MULTITEL_API_PASSWORD deur jou bediener se geheimekonfigurasie in voordat jy die voorbeelde gebruik. Moet dit nooit in openbare blaaier-JavaScript, URL's of bronbeheer inbed nie. Afsonderlike aanmeldbesonderhede word in API-integrasie-instellings bestuur.
Soek 'n nommer op
GET /v3/lrn/{number} aanvaar die bestemmingsnommer in die pad. 'n Opsionele beller se oorsprongnommer kan as /v3/lrn/{number}/{ani} vir oorsprongafhanklike inligting verskaf word. Gebruik Noord-Amerikaanse telefoonnommers wat uit syfers bestaan, met die landkode waar van toepassing; die voorbeelde gebruik gereserveerde fiktiewe nommers.
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"'n Opsoek met geldige aanmeldbesonderhede is faktureerbaar. Die tarief is USD 0,00025 per opsoek: USD 0,25 per 1 000 of USD 250 per miljoen. Daar is geen volumeafslag nie. Dit is 'n opsoek van roeteringsinligting; dit plaas nie 'n telefoonoproep nie.
Lees die resultaat
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Hierdie versinde voorbeeld demonstreer slegs die responsvorm; dit is nie 'n gemete roeteresultaat nie. Kontroleer status.code voordat jy response gebruik. Die cost-veld is 'n string met geldeenheidvoorvoegsel, nie 'n JSON-nommer nie.
| Veld | Betekenis |
|---|---|
lrn | Location Routing Number wat gebruik word om die roetebestemming te identifiseer. |
ported | Nommeroordragaanwyser wat deur hierdie opsoek verskaf word: tipies 0 of 1. Moet dit nie as bewys van eienaarskap of diensgeskiktheid gebruik nie. |
ocn | Operating Company Number, wanneer verskaf. |
lata | Local Access and Transport Area, wanneer verskaf. |
rc | Tariefsentrum, wanneer verskaf. |
city, state, lec, lectype, jurisdiction, local | Bykomende ligging-, diensverskaffer- of oorsprongverwante besonderhede wanneer beskikbaar. Hulle kan afwesig of leeg wees. |
Moenie vereis dat elke roeteringsveld teenwoordig is nie. Resultate vir tolvrye nommers kan veral plaaslike tariefsentrum- en diensverskafferkode-besonderhede weglaat. 'n Teruggegewe LRN is nie 'n intydse waarborg van bereikbaarheid of 'n oproepgehaltetoets nie.
Gebruik opsoeke in jou roetewerkvloei
- Valideer en normaliseer die aangevraagde nommer voordat jy dit stuur.
- Inspekteer HTTP- en toepassingstatus. Behou vir probleemoplossing 'n rekord van die nommer, tyd en resultaat waarvan sensitiewe besonderhede verwyder is.
- Gebruik slegs die velde wat relevant is vir jou roetereël en hanteer afwesige waardes uitdruklik.
- Begrens herprobeerslae na 'n onsekere respons. Om 'n opsoek te herhaal, kan 'n verdere koste veroorsaak; hierdie eindpunt het geen gedokumenteerde idempotensiesleutel nie.
Sien die LRN-produk en die vaste prys per opsoek. Die openbare OpenAPI-pad sluit 'n ANI-segment in; die ontplooide LRN-implementering aanvaar ook die korter versoek sonder ANI. lrninfo is 'n afsonderlike bewerking en moet nie in die plek van hierdie eindpunt gebruik word nie.
Hanteer foute en herprobeerslae
- Stawing- of toestemmingsfout
- Kontroleer of die API-aanmeldbesonderhede geaktiveer is, watter diens toegelaat word en watter bron-IP-beperking geld. 'n Portaal-sessiekoekie is nie aanmeldbesonderhede vir 'n integrasie nie.
- Onvoldoende krediet of ontbrekende vereiste goedkeuring
- Los eers enige probleem met die rekeningsaldo, versendingsgoedkeuring of dokumentvereiste op voordat jy die bewerking herhaal.
- Geen resultaat nie
- Hanteer leë voorraad of 'n ontbrekende bellernaam as 'n gewone uitkoms. Moenie aanneem dat 'n sintakties geldige nommer elke diens het nie.
- Netwerktydverstreking of diensfout
- Gebruik 'n beperkte aantal herprobeerslae met wagtye tussen pogings vir leesbewerkings. Vir 'n aankoop, versending of registrasie, inspekteer eers die bewerkingstatus; om 'n aanvaarde versoek weer te probeer, kan 'n faktureerbare aksie dupliseer.
Ondersteuning vir idempotensie is spesifiek aan elke API-familie. Die Emergency-API ondersteun sleutels vir herprobeerslae; dit maak nie arbitrêre v3-versoeke idempotent nie. Behou tydstempels, teruggegewe ID's en response waarvan sensitiewe besonderhede verwyder is vir ondersteuning.
Gaan voort met jou rekening se verwysing
Die verwysingsdokumentasie wat jy ná aanmelding sien, filtreer bewerkings volgens jou toestemmings en geaktiveerde dienste. Gebruik die presiese gasheer, tipe aanmeldbesonderhede, versoekvelde en responsskema daarin. Die konsoles kan werklike bewerkings uitvoer, insluitend aankope en die stuur van boodskappe.