REST API-dokumentation
REST API för LRN-routingsökning
Slå upp routingnumret och tillgänglig operatörsinformation för ett nordamerikanskt telefonnummer till ett fast pris.
Välj API och autentiseringsuppgift tillsammans
Godkända konton av typen Utvecklare & Automation, Företag och Kommunikationsleverantörer kan integrera aktiverade tjänster. En enskild utvecklare behöver inte utge sig för att vara ett företag. SMS/MMS för applikationer kräver tillämpligt sändningsgodkännande och tillämplig registrering. Tjänsten Privat & Familj har inget kundtillgängligt API för att initiera meddelandesändning.
| API-familj | Bas-URL | Autentisering och resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkända Basic-autentiseringsuppgifter; berättigade provisionerade token endast för åtgärder som stöder dem. JSON status och response. |
| Nödsamtalsregistrering | https://api.multi.tel/emergency | Godkända Basic-autentiseringsuppgifter eller specifikt provisionerad bearer-åtkomst. JSON code, message och data. |
| Portal-REST-integrationer | Värd och åtgärd visas i ditt kontos utvecklarreferens | Använd åtgärdens dokumenterade autentiseringsuppgift, behörighetsomfattning och schema. Begäranden från webbläsarsessioner använder ett separat gränssnitt. |
Ange MULTITEL_API_USERNAME och MULTITEL_API_PASSWORD via din servers konfiguration för hemligheter innan du använder exemplen. Bädda aldrig in dem i offentlig webbläsar-JavaScript, URL:er eller källkodshantering. Dedikerade autentiseringsuppgifter hanteras i inställningarna för API-integration.
Slå upp ett nummer
GET /v3/lrn/{number} tar emot destinationsnumret i sökvägen. Ett valfritt ursprungsnummer kan anges som /v3/lrn/{number}/{ani} för ursprungsberoende information. Ange nordamerikanska telefonnummer med endast siffror och landskod där det är tillämpligt; exemplen använder reserverade fiktiva nummer.
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"Att köra en slagning med giltiga autentiseringsuppgifter är debiterbart. Taxan är 0,00025 US$ per slagning: 0,25 US$ per 1 000 eller 250 US$ per miljon. Det finns inga volymrabatter. Detta är en slagning av dirigeringsinformation; den ringer inte upp något telefonsamtal.
Läs resultatet
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Detta påhittade exempel visar endast svarsstrukturen; det är inte ett uppmätt dirigeringsresultat. Kontrollera status.code innan du använder response. Fältet cost är en sträng med valutaprefix, inte ett JSON-tal.
| Fält | Betydelse |
|---|---|
lrn | Location Routing Number som används för att identifiera dirigeringsdestinationen. |
ported | Indikator för om numret är porterat, från denna slagning: vanligtvis 0 eller 1. Använd den inte som bevis på ägarskap eller tjänstberättigande. |
ocn | Operating Company Number, när det tillhandahålls. |
lata | Local Access and Transport Area, när det tillhandahålls. |
rc | Rate center, när det tillhandahålls. |
city, state, lec, lectype, jurisdiction, local | Ytterligare plats-, operatörs- eller ursprungsrelaterade uppgifter när de är tillgängliga. De kan saknas eller vara tomma. |
Kräv inte att alla dirigeringsfält finns. I synnerhet kan resultat för nummer som är avgiftsfria för den som ringer sakna uppgifter om lokalt rate center och operatörskod. Ett returnerat LRN är ingen realtidsgaranti för nåbarhet eller ett test av samtalskvalitet.
Använd slagningar i ditt dirigeringsarbetsflöde
- Validera och normalisera det begärda numret innan du skickar det.
- Granska HTTP- och applikationsstatus. Behåll en maskad post med nummer, tid och resultat för felsökning.
- Använd endast de fält som är relevanta för din dirigeringsregel och hantera saknade värden uttryckligen.
- Begränsa återförsök efter ett osäkert svar. En upprepad slagning kan medföra en ny avgift; denna slutpunkt har ingen dokumenterad idempotensnyckel.
Se LRN-produkten och fast prissättning. Den publika OpenAPI-sökvägen innehåller ett ANI-segment; den driftsatta LRN-implementationen accepterar även den kortare begäran utan ANI. lrninfo är en separat åtgärd och ska inte ersätta denna slutpunkt.
Hantera fel och återförsök
- Autentiserings- eller behörighetsfel
- Kontrollera API-autentiseringsuppgiftens aktiveringsstatus, tillåtna tjänst och käll-IP-begränsning. En portalsessionskaka är inte en integrationsautentiseringsuppgift.
- Otillräckligt saldo eller saknat godkännande
- Åtgärda kontosaldot, sändningsgodkännandet eller dokumentkravet innan du upprepar åtgärden.
- Inget resultat
- Hantera tomt lager eller ett saknat uppringarnamn som ett normalt utfall. Anta inte att ett syntaktiskt giltigt nummer har alla tjänster.
- Nätverkstimeout eller tjänstefel
- Använd begränsade återförsök med backoff för läsningar. Vid köp, sändning eller registrering ska du först granska åtgärdens tillstånd; ett återförsök av en accepterad begäran kan duplicera en debiterbar åtgärd.
Idempotensstöd tillhör varje API-familj. Emergency API stöder återförsöksnycklar; det gör inte godtyckliga v3-begäranden idempotenta. Behåll tidsstämplar, returnerade ID:n och maskade svar för supporten.
Fortsätt med ditt kontos referens
Den inloggade referensen filtrerar operationer utifrån dina behörigheter och aktiverade tjänster. Använd dess exakta värd, typ av autentiseringsuppgift, förfrågningsfält och svarsschema. Konsolerna kan utföra skarpa operationer, inklusive köp och meddelanden.