Hae soittajan nimi
Hae puhelinnumerolle saatavilla oleva soittajan nimitieto. Haku tehdään tuotantoympäristössä, ja siitä voidaan veloittaa tiliäsi myös silloin, kun tulos saadaan palvelun välimuistista. Haku ei muuta omistamastasi numerosta soitettavissa puheluissa näkyvää nimeä.
Palautettu nimi ei vahvista henkilöllisyyttä, omistajuutta eikä lupaa soittaa. Nimi voi puuttua, olla vanhentunut tai lyhennetty, olla maantieteellinen nimike tai sen tilalla voi olla puhelinnumero korvaavana arvona.
Pyyntö
Käytä aktivoitua API-tiliäsi sille sallitusta lähde-IP-osoitteesta. Säilytä tunnistetiedot palvelinpuolen salaisuuksien tallennusratkaisussa. Esimerkissä käytetään ympäristömuuttujia ja kuvitteellista pohjoisamerikkalaista numeroa; älä sijoita tunnistetietoja URL-osoitteisiin tai julkiseen selainkoodiin.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
https://api.multitel.net/v3/cnam/12025550123Anna koko numero numeroina maatunnus mukaan lukien, esimerkiksi Pohjois-Amerikan numero yksitoistanumeroisena ja numerolla 1 alkavana. Älä luota siihen, että käsittelijä normalisoi välimerkit tai plusmerkin. Pyynnön runkoa tai aluevalitsinta ei tarvita. Varmista MultiTELiltä käyttötarkoituksesi tuettu kattavuus.
Vastaus
Arvot ovat vain esimerkkejä; kustannus ei ole hintatarjous.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"number": "12025550123",
"name": "EXAMPLE NAME",
"cost": 0.0037,
"balance": 9.9963
}
}| Kenttä | Merkitys |
|---|---|
| number | Pyynnössä annettu numero. |
| name | Saatavilla oleva nimi tai korvaava teksti. Se ei ole henkilöllisyyden vahvistus. |
| cost | Tämän käsittelypolun ilmoittama tilille tai palvelulle määritetty hakuhinta. Käytä tilin voimassa olevaa hintaa, älä esimerkkiarvoa. |
| balance | Vastausta varten laskettu saldo. Kyseessä ei ole uusi transaktionaalinen tilin saldokysely. |
Veloitukset ja täsmäytys
Nimen sisältävistä tuloksista veloitetaan tilille määritetty CNAM-hinta. Toistettu tai välimuistista tehty haku voi aiheuttaa uuden veloituksen; idempotenssiavainta ei ole tarjolla. Tarkista tilin voimassa oleva hinta ennen automaattisten hakujen käyttöönottoa.
Vastauksessa on tunnettu rajoitus, kun välimuistissa oleva nimi on tyhjä: käsittelijä voi palauttaa API-koodin 200 sekä tyhjän nimen, nollasta poikkeavan kustannuksen ja pienennetyn laskennallisen saldon, vaikka kyseinen käsittelyhaara ei veloita tiliä. Älä pidä pelkkää vastausta todisteena veloituksesta. Täsmäytä tiedot tilin laskutustietoihin ja tee uusi saldohaku, ja ota yhteyttä tukeen, jos tulokset ovat epäselviä.
Ennakkoon maksetun saldon tarkistus edellyttää tällä hetkellä vähintään 0.004 saldoa ennen hakua riippumatta määritetystä kyselykohtaisesta hinnasta. Myös tili, jolla ostot on poistettu käytöstä, hylätään. Nämä tarkistukset eivät tee tästä päätepisteestä hintatarjousten tai kulutusrajojen API-rajapintaa.
Virheet ja uudelleenyritykset
Tarkista sekä HTTP-tila että JSON-vastauksen status.code/status.msg. API-koodi 403 voi tarkoittaa riittämätöntä ennakkoon maksettua saldoa, ostokieltoa, tilin valtuutusongelmaa tai sitä, ettei soittajan nimeä löytynyt. Käsittelypolku, jossa nimeä ei löydy, voi palauttaa koodin merkkijonona. Tarkista viesti sen sijaan, että tulkitsisit jokaisen 403-koodin virheellisiksi tunnistetiedoiksi. Asetusristiriidat voivat palauttaa API-koodin 500.
Aikakatkaisu voi tapahtua laskutettavan haun jälkeen. Käytä rajattua määrää uudelleenyrityksiä kasvavin odotusajoin vain silloin, kun se sopii sovellukseesi, ja täsmäytä ensin yritykset, joiden lopputulos on epävarma. Älä yritä toistuvasti uudelleen hylättyä numeroa tai hakua, joka epäonnistui tilin käyttöoikeus- tai saldo-ongelman vuoksi. Oman sovelluksesi vastausvälimuisti voi vähentää toistuvia pyyntöjä sopimuksesi ja tarkkuusvaatimustesi sallimissa rajoissa.
Muut numerotoiminnot
Tämä lukutoiminto on erillinen lähtevissä puheluissa näkyvän nimen tai LIDB-tietojen päivityksestä, hakemistomerkinnästä ja soittajan rekisteröinnistä. Näillä toiminnoilla on omat pakolliset kenttänsä, valtuutusvaatimuksensa ja maksunsa. Käytä toimintoa numeroalueiden kattavuus numeron etuliitetaulukon tarkistamiseen tai toimintoa numerohaku tilattavissa olevien numeroiden tarkasteluun. Mikään näistä ei vahvista, että soittaja on se, joka hän väittää olevansa.