CNAM-integraatio

CNAM REST API -viite

Pyydä soittajan nimeä HTTPS:n yli ja käsittele tulos, maksu ja virheet.

Valitse haun toimintatapa

Taso	Julkinen hinta per kysely	Mitä se tekee
Starter	0,0026 $	Käyttää omia ja välimuistiin tallennettuja soittajien nimitietoja.
Standard	0,0037 $	Tekee reaaliaikaisen verkkohaun jokaiselle kyselylle.
Mixed	0,004 $	Yrittää ensin reaaliaikaista hakua ja käyttää Starter-tietoja, jos nimeä ei löydy.

Valittu palvelu määrittää haun toimintatavan; Mixed ei hae ensin välimuistista. Tarkista tilillesi määritetty hinta ennen tuotantokäyttöä. Soittajan nimi ei todista henkilöllisyyttä tai omistajuutta.

Lähetä todennettu hakupyyntö

Päätepiste: GET https://api.multitel.net/v3/cnam/NUMBER. Käytä kansainvälisessä muodossa olevia puhelinnumeroita maatunnuksineen, vain numeroita ilman välimerkkejä tai alussa olevaa plusmerkkiä. Suorita pyyntö sovelluspalvelimeltasi hyväksytyillä API-tunnistetiedoilla.

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/cnam/12025550123"

Anna kaksi ympäristömuuttujaa palvelinpuolen salaisuuksien hallinnan kautta. Provisionoitu bearer-tunnistetieto on vaihtoehto vain, kun kyseinen käyttöoikeus on aktivoitu ja sen lähde-IP-rajoitukset täyttyvät. Älä koskaan sisällytä API-salaisuutta julkiseen selainkoodipakettiin.

API-todennuksen ja ensimmäisen pyynnön opas

Lue JSON-vastaus

Tämä vastaus on havainnollistava. Palautettu nimi ja maksu riippuvat hausta ja valitusta palvelusta.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE CALLER",
    "cost": "0.004",
    "balance": "24.9960"
  }
}

status.code: Sovelluksen tuloskoodi; normalisoi merkkijono- ja lukuarvot ennen vertaamista arvoon 200.
status.msg: Liittyvä tulos- tai hylkäysviesti.
response.number: Kyselyn kohteena ollut numero.
response.name: Saatavilla oleva soittajan nimi.
response.cost: Tälle kyselylle ilmoitettu maksu; käsittele se desimaalimääränä.
response.balance: Raportoitu tilin saldo, jos saatavilla.

Tulokset ilman nimeä ja virheet

Onnistunut pyyntö ei takaa käyttökelpoista soittajan nimeä. Käsittele tyhjä nimi, nimen sijaan palautettu numero ja hylätty haku. Sovelluskoodi 403 voi tarkoittaa riittämätöntä saldoa, kiellettyä ostoa tai numeroa, jolle ei löydy tulosta; tarkista viesti.

Tarkista sekä HTTP-tila että JSON-vastauksen status ennen response.name-kentän lukemista. Vastausobjekti voi puuttua virhetilanteessa. Puuttuva nimi ei saa estää normaalin puhelun reititystä.

Laskutus, uudelleenyritykset ja ero soittajatunnuksen päivittämiseen

Uusi haku voi aiheuttaa kyselymaksun. Näille hakurajapinnoille ei ole dokumentoitu idempotenssiavainta, joten uusi yritys voi olla toinen laskutettava kysely. Käytä siirto- tai palveluvirheissä rajallista määrää uudelleenyrityksiä kasvavalla viiveellä, ratkaise tilivirheet ensin ja täsmäytä raportoidut kyselymaksut. Säilytä tiedot välimuistissa vain sovelluksellesi sopivan ajan; soittajien nimitiedot voivat muuttua.

CNAM-haku lukee nimen. Se ei muuta lähtevissä puheluissasi näkyvää nimeä. Soittajan nimen päivitys LIDB:hen on erillinen toiminto, jolla on omat kenttänsä, valtuutuksensa, hintansa ja käsittelynsä.

Tilin CNAM-integraatio-opas Pyydä apua integraatioon