REST API -dokumentaatio
LRN-reititystietojen REST API -haku
Hae Pohjois-Amerikan puhelinnumeron reititysnumero ja saatavilla olevat operaattoritiedot kiinteällä hakukohtaisella hinnalla.
Valitse API ja tunnistetieto yhdessä
Hyväksytyt Kehittäjät ja automaatio-, Yritys- ja Viestintäpalveluntarjoajat-tilit voivat integroida käytössä olevia palveluja. Yksittäisen kehittäjän ei tarvitse esiintyä yrityksenä. Sovellusten SMS/MMS edellyttää soveltuvaa lähetyshyväksyntää ja rekisteröintiä. Henkilöt ja perheet -palvelulla ei ole asiakkaan käytettävissä olevaa viestien lähetyksen API-rajapintaa.
| API-perhe | Perus-URL | Todennus ja tulos |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Hyväksytyt Basic-tunnistetiedot; oikeutetut provisionoidut tunnukset vain toimintoihin, jotka tukevat niitä. JSON-muotoiset status ja response. |
| Hätäpalvelun rekisteröinti | https://api.multi.tel/emergency | Hyväksytyt Basic-tunnistetiedot tai erikseen provisionoitu bearer-käyttöoikeus. JSON-muotoiset code, message ja data. |
| Portaalin REST-integraatiot | Isäntä ja toiminto on esitetty tilisi kehittäjäviitteessä | Käytä kyseisen toiminnon dokumentoitua tunnistetietoa, käyttöoikeuksia ja skeemaa. Selainistunnon pyynnöt ovat erillinen rajapinta. |
Määritä MULTITEL_API_USERNAME ja MULTITEL_API_PASSWORD palvelimesi salaisuuksien hallinnan kautta ennen esimerkkien käyttöä. Älä koskaan upota niitä julkiseen selaimen JavaScript-koodiin, URL-osoitteisiin tai versionhallintaan. Erillisiä tunnistetietoja hallitaan kohdassa API-integraation asetukset.
Hae numeron tiedot
GET /v3/lrn/{number} hyväksyy kohdenumeron polussa. Valinnaisen soittavan numeron voi antaa muodossa /v3/lrn/{number}/{ani} alkuperästä riippuvia tietoja varten. Anna Pohjois-Amerikan puhelinnumerot pelkkinä numeroina ja sisällytä maatunnus tarvittaessa; esimerkeissä käytetään varattuja kuvitteellisia numeroita.
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"Haku kelvollisilla tunnistetiedoilla on laskutettava. Hinta on 0,00025 $ hakua kohti: 0,25 $ / 1 000 tai 250 $ / miljoona. Määräalennuksia ei ole. Tämä on reititystietojen haku; se ei soita puhelua.
Lue tulos
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Tämä keksitty esimerkki havainnollistaa vain vastauksen rakennetta; se ei ole mitattu reititystulos. Tarkista status.code ennen response-elementin käyttöä. cost-kenttä on valuuttaetuliitteinen merkkijono, ei JSON-numero.
| Kenttä | Merkitys |
|---|---|
lrn | Location Routing Number, joka yksilöi reitityskohteen. |
ported | Tämän haun antama tieto siitä, onko numero siirretty: tyypillisesti 0 tai 1. Älä käytä sitä omistajuuden tai palvelukelpoisuuden todisteena. |
ocn | Operating Company Number, jos annettu. |
lata | Local Access and Transport Area, jos annettu. |
rc | Rate center, jos annettu. |
city, state, lec, lectype, jurisdiction, local | Muita sijaintiin, operaattoriin tai alkuperään liittyviä tietoja, kun saatavilla. Ne voivat puuttua tai olla tyhjiä. |
Älä edellytä, että jokainen reitityskenttä on mukana. Erityisesti soittajalle maksuttomien numeroiden tuloksista voivat puuttua paikalliset rate-center- ja operaattorikooditiedot. Palautettu LRN ei ole reaaliaikainen tae tavoitettavuudesta eikä puhelun laadun testi.
Käytä hakuja reititystyönkulussasi
- Tarkista pyydetyn numeron kelvollisuus ja normalisoi sen muoto ennen lähettämistä.
- Tarkista HTTP- ja sovellustila. Säilytä vianmääritystä varten sensuroitu kirjaus numerosta, ajankohdasta ja tuloksesta.
- Käytä vain reitityssääntösi kannalta merkityksellisiä kenttiä ja käsittele puuttuvat arvot nimenomaisesti.
- Rajoita uudelleenyritykset epävarman vastauksen jälkeen. Haun toistaminen voi aiheuttaa uuden veloituksen; tällä päätepisteellä ei ole dokumentoitua idempotenssiavainta.
Katso LRN-tuote ja kiinteä hinnoittelu. Julkinen OpenAPI-polku sisältää ANI-segmentin; käyttöön otettu LRN-toteutus hyväksyy myös lyhyemmän pyynnön ilman ANI-tunnusta. lrninfo on erillinen toiminto, eikä sitä pidä käyttää tämän päätepisteen korvikkeena.
Käsittele virheet ja uudelleenyritykset
- Todennus- tai käyttöoikeusvirhe
- Tarkista API-tunnistetiedon käytössäolotila, sallittu palvelu ja lähde-IP-rajoitus. Portaalin istuntoeväste ei ole integraation tunnistetieto.
- Riittämätön saldo tai puuttuva hyväksyntä
- Selvitä tilin saldo, lähetyshyväksyntä tai asiakirjavaatimus ennen toiminnon toistamista.
- Ei tulosta
- Käsittele tyhjää varastoa tai puuttuvaa soittajan nimeä tavallisena tuloksena. Älä oleta, että syntaktisesti kelvollisella numerolla on kaikki palvelut.
- Verkon aikakatkaisu tai palveluvirhe
- Käytä lukutoiminnoissa rajoitettuja uudelleenyrityksiä viiveen pidennyksellä. Tarkista oston, lähetyksen tai rekisteröinnin yhteydessä ensin toiminnon tila; hyväksytyn pyynnön uudelleenyritys voi monistaa laskutettavan toiminnon.
Idempotenssituki määräytyy API-perhekohtaisesti. Emergency API tukee uudelleenyritysavaimia; se ei tee mielivaltaisista v3-pyynnöistä idempotentteja. Säilytä aikaleimat, palautetut tunnukset ja sensuroidut vastaukset tukea varten.
Jatka tilisi viiteaineistoon
Kirjautuneen käyttäjän viiteaineisto näyttää toiminnot käyttöoikeuksien ja käytössä olevien palvelujen mukaan. Käytä siinä ilmoitettua tarkkaa isäntää, tunnistetietotyyppiä, pyyntökenttiä ja vastausskeemaa. Konsolit voivat suorittaa todellisia toimintoja, myös ostoja ja viestien lähetyksiä.