REST API-dokumentation
REST API til LRN-routingopslag
Slå routingnummeret og de tilgængelige oplysninger om operatøren op for et nordamerikansk telefonnummer til en fast pris.
Vælg API og legitimation sammen
Godkendte konti med profilerne Udvikler og automatisering, Erhverv og Kommunikationsudbydere kan integrere aktiverede tjenester. En individuel udvikler behøver ikke give sig ud for at være en virksomhed. SMS/MMS fra applikationer kræver den relevante afsendelsesgodkendelse og registrering. Tjenesten for Privatpersoner og familier har ingen API tilgængelig for kunder til afsendelse af beskeder.
| API-familie | Basis-URL | Autentificering og resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkendt Basic-legitimation; kvalificerede tildelte tokens kun til handlinger, der understøtter dem. JSON status og response. |
| Nødopkaldsregistrering | https://api.multi.tel/emergency | Godkendt Basic-legitimation eller specifikt tildelt bearer-adgang. JSON code, message og data. |
| Portal-REST-integrationer | Vært og handling vist i din kontos udviklerreference | Brug den pågældende handlings dokumenterede legitimation, scopes og skema. Anmodninger fra browsersessioner bruger en separat grænseflade. |
Angiv MULTITEL_API_USERNAME og MULTITEL_API_PASSWORD via din servers konfiguration af hemmeligheder, før du bruger eksemplerne. Indlejr dem aldrig i offentlig JavaScript i browseren, i URL’er eller i kildekodestyring. Dedikerede legitimationsoplysninger administreres i indstillinger for API-integration.
Slå et nummer op
GET /v3/lrn/{number} accepterer destinationsnummeret i stien. Et valgfrit nummer for den, der ringer op, kan angives som /v3/lrn/{number}/{ani} til oplysninger, der afhænger af oprindelsen. Brug nordamerikanske telefonnumre med kun cifre og landekode, hvor det er relevant; eksemplerne bruger reserverede fiktive numre.
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"Et opslag med gyldig legitimation medfører betaling. Prisen er 0,00025 US$ pr. opslag: 0,25 US$ pr. 1.000 eller 250 US$ pr. million. Der gives ingen mængderabatter. Dette er et opslag af routingoplysninger; det foretager ikke noget telefonopkald.
Læs resultatet
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Dette opdigtede eksempel viser kun svarets opbygning; det er ikke et målt routingresultat. Kontrollér status.code, før du bruger response. Feltet cost er en streng med valutapræfiks og ikke et JSON-tal.
| Felt | Betydning |
|---|---|
lrn | Location Routing Number, der bruges til at identificere routingdestinationen. |
ported | Portabilitetsindikator fra dette opslag: typisk 0 eller 1. Brug den ikke som bevis for ejerskab eller berettigelse til tjenester. |
ocn | Operating Company Number, når det er angivet. |
lata | Local Access and Transport Area, når det er angivet. |
rc | Rate center, når det er angivet. |
city, state, lec, lectype, jurisdiction, local | Yderligere oplysninger om placering, operatør eller oprindelse, når de er tilgængelige. De kan mangle eller være tomme. |
Kræv ikke, at alle routingfelter er til stede. Især kan resultater for gratisnumre udelade lokale rate center- og operatørkodeoplysninger. Et returneret LRN er ikke en realtidsgaranti for, at nummeret kan nås, og er ikke en test af opkaldskvalitet.
Brug opslag i din routingproces
- Validér og normalisér det ønskede nummer, før du sender det.
- Kontrollér både HTTP-status og applikationsstatus. Gem til fejlfinding en registrering af nummer, tidspunkt og resultat, hvor følsomme oplysninger er fjernet.
- Brug kun de felter, der er relevante for din routingregel, og håndtér manglende værdier eksplicit.
- Begræns nye forsøg efter et usikkert svar. Gentagelse af et opslag kan give endnu en afgift; dette endpoint har ingen dokumenteret idempotensnøgle.
Se LRN-produktet og den faste pris. Den offentlige OpenAPI-sti indeholder et ANI-segment; den implementerede LRN-løsning accepterer også den kortere anmodning uden ANI. lrninfo er en separat handling og bør ikke erstatte dette endpoint.
Håndtering af fejl og nye forsøg
- Fejl i autentificering eller tilladelser
- Kontrollér, om API-legitimationen er aktiveret, hvilken tjeneste den har tilladelse til, og hvilke begrænsninger der gælder for kilde-IP. En portalsessions-cookie er ikke en integrationslegitimation.
- Utilstrækkelig saldo eller manglende godkendelse
- Løs problemet med kontosaldoen, afsendelsesgodkendelsen eller dokumentkravet, før du gentager handlingen.
- Intet resultat
- Behandl et tomt lager eller et manglende opkaldsnavn som et almindeligt udfald. Antag ikke, at et syntaktisk gyldigt nummer har alle tjenester.
- Netværkstimeout eller tjenestefejl
- Brug begrænsede nye forsøg med backoff ved læsninger. Ved et køb, en afsendelse eller en registrering skal du først kontrollere handlingens tilstand; et nyt forsøg på en accepteret anmodning kan duplikere en handling, der medfører betaling.
Understøttelse af idempotens gælder for den enkelte API-familie. Emergency API’et understøtter nøgler til nye forsøg; det gør ikke vilkårlige v3-anmodninger idempotente. Gem tidsstempler, returnerede ID’er og svar, hvor følsomme oplysninger er fjernet, til support.
Fortsæt med din kontos reference
Den indloggede reference filtrerer operationer efter dine rettigheder og aktiverede tjenester. Brug dens præcise host, legitimationstype, forespørgselsfelter og svarskema. Konsollerne kan udføre live-operationer, herunder køb og beskeder.