REST API-dokumentasjon
REST API for LRN-rutingoppslag
Slå opp rutingnummeret og tilgjengelig operatørinformasjon for et nordamerikansk telefonnummer til en fast pris.
Velg API og legitimasjon sammen
Godkjente kontoer av typen Utvikler og automatisering, Bedrift og Kommunikasjonsleverandører kan integrere aktiverte tjenester. En individuell utvikler trenger ikke å utgi seg for å være et selskap. Applikasjons-SMS/MMS krever gjeldende sendingsgodkjenning og registrering. Tjenesten Privat og familie har ingen kundetilgjengelig API for å starte meldingssending.
| API-familie | Basis-URL | Autentisering og resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkjente Basic-legitimasjoner; kvalifiserte, klargjorte tokener bare for operasjoner som støtter dem. JSON status og response. |
| Registrering for nødanrop | https://api.multi.tel/emergency | Godkjente Basic-legitimasjoner eller spesifikt klargjort bearer-tilgang. JSON code, message og data. |
| Portal REST-integrasjoner | Vert og operasjon vises i kontoens utviklerreferanse | Bruk operasjonens dokumenterte legitimasjon, scopes og skjema. Forespørsler fra nettleserøkten er et separat grensesnitt. |
Angi MULTITEL_API_USERNAME og MULTITEL_API_PASSWORD via serverens hemmelighetskonfigurasjon før du bruker eksemplene. Legg dem aldri inn i offentlig nettleser-JavaScript, URL-er eller kildekontroll. Dedikerte legitimasjoner administreres i API-integrasjonsinnstillinger.
Slå opp et nummer
GET /v3/lrn/{number} godtar destinasjonsnummeret i banen. Et valgfritt opprinnelsesnummer kan oppgis som /v3/lrn/{number}/{ani} for opprinnelsesavhengig informasjon. Oppgi nordamerikanske telefonnumre med bare sifre og landkode der det er aktuelt; eksemplene bruker reserverte 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"Å kjøre et oppslag med gyldig legitimasjon er fakturerbart. Satsen er 0,00025 USD per oppslag: 0,25 USD per 1 000 eller 250 USD per million. Det gis ingen volumbaserte rabatter. Dette er et oppslag av rutingsinformasjon; det foretar ikke et telefonanrop.
Les resultatet
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Dette oppdiktede eksemplet viser bare responsformen; det er ikke et målt rutingsresultat. Kontroller status.code før du bruker response. Feltet cost er en streng med valutaprefiks, ikke et JSON-tall.
| Felt | Betydning |
|---|---|
lrn | Location Routing Number som brukes til å identifisere rutingsdestinasjonen. |
ported | Indikator for om nummeret er portert, fra dette oppslaget: vanligvis 0 eller 1. Ikke bruk den som bevis på eierskap eller tjenesteberettigelse. |
ocn | Operating Company Number, når det oppgis. |
lata | Local Access and Transport Area, når det oppgis. |
rc | Rate center, når det oppgis. |
city, state, lec, lectype, jurisdiction, local | Ytterligere steds-, operatør- eller opprinnelsesrelaterte detaljer når de er tilgjengelige. De kan være fraværende eller tomme. |
Ikke krev at alle rutingsfelt er til stede. Særlig kan resultater for numre som er gratis å ringe til, utelate lokale takstsenter- og operatørkodedetaljer. Et returnert LRN er ingen sanntidsgaranti for tilgjengelighet eller en test av samtalekvalitet.
Bruk oppslag i rutingsarbeidsflyten din
- Valider og normaliser det forespurte nummeret før du sender det.
- Undersøk HTTP- og applikasjonsstatus. Behold en sladdet registrering av nummer, tidspunkt og resultat for feilsøking.
- Bruk bare feltene som er relevante for rutingsregelen din, og håndter manglende verdier eksplisitt.
- Begrens nye forsøk etter en usikker respons. Å gjenta et oppslag kan gi et nytt gebyr; dette endepunktet har ingen dokumentert idempotensnøkkel.
Se LRN-produktet og den faste prisen per oppslag. Den offentlige OpenAPI-banen inneholder et ANI-segment; LRN-implementasjonen i drift godtar også den kortere forespørselen uten ANI. lrninfo er en separat operasjon og skal ikke erstatte dette endepunktet.
Håndter feil og nye forsøk
- Autentiserings- eller tillatelsesfeil
- Kontroller API-legitimasjonens aktiverte tilstand, tillatte tjeneste og kilde-IP-begrensning. En informasjonskapsel for portaløkten er ikke en integrasjonslegitimasjon.
- Utilstrekkelig kreditt eller manglende godkjenning
- Løs problemet med kontosaldo, sendingsgodkjenning eller dokumentkrav før du gjentar operasjonen.
- Ingen resultater
- Behandle tomt lager eller manglende innringernavn som et vanlig utfall. Ikke anta at et syntaktisk gyldig nummer har alle tjenester.
- Nettverkstidsavbrudd eller tjenestefeil
- Bruk begrensede nye forsøk med backoff for lesinger. For et kjøp, en sending eller en registrering må du først undersøke operasjonens tilstand; å prøve en akseptert forespørsel på nytt kan duplisere en fakturerbar handling.
Idempotensstøtte tilhører hver API-familie. Emergency API støtter nøkler for nye forsøk; det gjør ikke vilkårlige v3-forespørsler idempotente. Behold tidsstempler, returnerte ID-er og sladdede responser for brukerstøtte.
Fortsett med referansen for kontoen din
Den innloggede referansen filtrerer operasjoner etter tillatelsene dine og aktiverte tjenester. Bruk nøyaktig vert, legitimasjonstype, forespørselsfelt og responsskjema der. Konsollene kan utføre live-operasjoner, inkludert kjøp og meldinger.