REST API-documentatie
LRN-routeringsopzoek-REST-API
Zoek tegen een vaste prijs het routeringsnummer en de beschikbare carrierinformatie op voor een Noord-Amerikaans telefoonnummer.
Kies de API en de inloggegevens samen
Goedgekeurde accounts met het profiel Ontwikkelaars en automatisering, Zakelijk of Communicatieaanbieders kunnen ingeschakelde diensten integreren. Een individuele ontwikkelaar hoeft zich niet als bedrijf voor te doen. Applicatie-SMS/MMS vereist de toepasselijke verzendgoedkeuring en registratie. De dienst voor Particulieren en gezinnen heeft geen voor klanten toegankelijke API voor het verzenden van berichten.
| API-familie | Basis-URL | Authenticatie en resultaat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Goedgekeurde Basic-inloggegevens; in aanmerking komende geprovisioneerde tokens alleen voor bewerkingen die deze ondersteunen. JSON status en response. |
| Noodregistratie | https://api.multi.tel/emergency | Goedgekeurde Basic-inloggegevens of specifiek geprovisioneerde bearer-toegang. JSON code, message en data. |
| REST-integraties van de portal | Host en bewerking zoals getoond in de ontwikkelaarsreferentie van uw account | Gebruik de gedocumenteerde inloggegevens, scopes en het schema van die bewerking. Verzoeken vanuit een browsersessie vormen een afzonderlijke interface. |
Stel MULTITEL_API_USERNAME en MULTITEL_API_PASSWORD in via de geheime configuratie van uw server voordat u de voorbeelden gebruikt. Sluit ze nooit in in openbaar browser-JavaScript, URL’s of broncodebeheer. Specifieke inloggegevens beheert u in de instellingen voor API-integratie.
Een nummer opzoeken
GET /v3/lrn/{number} accepteert het bestemmingsnummer in het pad. Een optioneel nummer van de beller kan worden opgegeven als /v3/lrn/{number}/{ani} voor informatie die van de oorsprong afhangt. Gebruik Noord-Amerikaanse telefoonnummers met alleen cijfers en waar van toepassing de landcode; de voorbeelden gebruiken gereserveerde fictieve nummers.
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"Een opzoeking uitvoeren met geldige inloggegevens is factureerbaar. Het tarief is US$ 0,00025 per opzoeking: US$ 0,25 per 1.000 of US$ 250 per miljoen. Er zijn geen volumekortingen. Dit is een opzoeking van routeringsinformatie; er wordt geen telefoongesprek mee gestart.
Het resultaat lezen
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Dit verzonnen voorbeeld toont alleen de vorm van het antwoord; het is geen gemeten routeringsresultaat. Controleer status.code voordat u response gebruikt. Het veld cost is een string met valutavoorvoegsel, geen JSON-getal.
| Veld | Betekenis |
|---|---|
lrn | Location Routing Number waarmee de routeringsbestemming wordt geïdentificeerd. |
ported | Portabiliteitsindicator die door deze opzoeking wordt geleverd: doorgaans 0 of 1. Gebruik deze niet als bewijs van eigendom of geschiktheid voor een dienst. |
ocn | Operating Company Number, indien verstrekt. |
lata | Local Access and Transport Area, indien verstrekt. |
rc | Rate center, indien verstrekt. |
city, state, lec, lectype, jurisdiction, local | Aanvullende gegevens over locatie, provider of oorsprong wanneer beschikbaar. Ze kunnen ontbreken of leeg zijn. |
Niet elk routeringsveld hoeft aanwezig te zijn. Met name bij nummers die gratis zijn voor de beller kunnen lokale rate-center- en providercodegegevens ontbreken. Een geretourneerde LRN is geen realtimegarantie voor bereikbaarheid en ook geen test van de gesprekskwaliteit.
Opzoekingen gebruiken in uw routeringsworkflow
- Valideer en normaliseer het opgevraagde nummer voordat u het verzendt.
- Controleer de HTTP-status en de applicatiestatus. Bewaar voor probleemoplossing een registratie van nummer, tijdstip en resultaat waaruit gevoelige gegevens zijn verwijderd.
- Gebruik alleen de velden die relevant zijn voor uw routeringsregel en behandel ontbrekende waarden expliciet.
- Begrens nieuwe pogingen na een onzeker antwoord. Een opzoeking herhalen kan opnieuw kosten opleveren; dit eindpunt heeft geen gedocumenteerde idempotentiesleutel.
Bekijk het LRN-product en de vaste prijzen. Het openbare OpenAPI-pad bevat een ANI-segment; de ingezette LRN-implementatie accepteert ook het kortere verzoek zonder ANI. lrninfo is een aparte bewerking en mag niet in de plaats van dit eindpunt worden gebruikt.
Fouten en nieuwe pogingen afhandelen
- Fout in authenticatie of machtiging
- Controleer of de API-inloggegevens zijn ingeschakeld, welke dienst is toegestaan en welke beperking voor het bron-IP-adres geldt. Een sessiecookie van het portaal is geen inloggegeven voor integratie.
- Onvoldoende tegoed of niet voldaan aan goedkeuring
- Los het accountsaldo, de verzendgoedkeuring of de documentvereiste op voordat u de handeling herhaalt.
- Geen resultaat
- Behandel een lege voorraad of een ontbrekende naam van de beller als een gewone uitkomst. Ga er niet van uit dat een syntactisch geldig nummer alle diensten heeft.
- Netwerktime-out of storing van de dienst
- Gebruik begrensde nieuwe pogingen met backoff voor leesopdrachten. Controleer bij een aankoop, verzending of registratie eerst de status van de bewerking; een geaccepteerd verzoek opnieuw proberen kan een factureerbare handeling dupliceren.
Ondersteuning voor idempotentie verschilt per API-familie. De Emergency API ondersteunt sleutels voor herhaalde pogingen; dat maakt willekeurige v3-verzoeken niet idempotent. Bewaar tijdstempels, geretourneerde ID’s en antwoorden waaruit gevoelige gegevens zijn verwijderd voor ondersteuning.
Ga verder met de referentie van uw account
De referentie voor ingelogde gebruikers filtert bewerkingen op basis van uw rechten en ingeschakelde diensten. Gebruik de exacte host, het credentialtype, de aanvraagvelden en het responsschema die daarin staan. De consoles kunnen live bewerkingen uitvoeren, waaronder aankopen en berichten.