CNAM integracija

CNAM REST API žinynas

Užklauskite skambintojo vardo per HTTPS ir tvarkykite rezultatą, mokestį ir klaidas.

Pasirinkite užklausos elgseną

Lygis	Vieša kaina už užklausą	Ką jis daro
Starter	0,0026 USD	Naudoja nuosavybės teise valdomą ir talpykloje saugomą skambintojo vardų informaciją.
Standard	0,0037 USD	Kiekvienai užklausai atlieka realaus laiko tinklo užklausą.
Mixed	0,004 USD	Pirmiausia bando realaus laiko užklausą, o jei vardas nerastas, naudoja Starter duomenis.

Užklausos elgseną lemia pasirinkta paslauga; Mixed nėra pirmiausia talpyklą naudojanti užklausa. Prieš pradėdami naudoti realioje veikloje, peržiūrėkite jūsų paskyrai priskirtą įkainį. Skambintojo vardas nėra tapatybės ar nuosavybės įrodymas.

Siųskite autentifikuotą užklausą

Galinis taškas: GET https://api.multitel.net/v3/cnam/NUMBER. Naudokite tarptautinius skaitmenis su šalies kodu, be skyrybos ženklų ir be pradinio pliuso. Vykdykite tai iš savo programos serverio, naudodami patvirtintus API prisijungimo duomenis.

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

Pateikite du aplinkos kintamuosius per serverio pusės paslapčių konfigūraciją. Suteiktas bearer prisijungimo raktas yra alternatyva tik tada, kai ši prieiga įjungta ir tenkinami jos šaltinio IP apribojimai. Niekada nedėkite API paslapties į viešą naršyklės paketą.

API autentifikavimo ir pirmosios užklausos vadovas

Perskaitykite JSON atsakymą

Šis atsakymas yra iliustracinis. Grąžintas vardas ir mokestis priklauso nuo užklausos ir pasirinktos paslaugos.

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

status.code: Programos rezultato kodas; prieš lygindami su 200, normalizuokite eilutės ir skaitines reikšmes.
status.msg: Lydintis rezultato arba atmetimo pranešimas.
response.number: Užklaustas numeris.
response.name: Galimas skambintojo vardas.
response.cost: Už šią užklausą nurodytas mokestis; traktuokite jį kaip dešimtainę sumą.
response.balance: Nurodytas paskyros likutis, kai jis pateikiamas.

Rezultatai be vardo ir klaidos

Sėkminga užklausa negarantuoja naudingo skambintojo vardo. Tvarkykite tuščią vardą, vietoj vardo grąžintą numerį ir atmestą užklausą. Programos kodas 403 gali reikšti nepakankamą kreditą, draudžiamą pirkimą arba numerį be rezultato; patikrinkite pranešimą.

Prieš pasiekdami response.name, patikrinkite ir HTTP būsenos kodą, ir JSON status. Įvykus klaidai atsakymo objekto gali nebūti. Trūkstamas vardas neturėtų trukdyti nukreipti įprasto skambučio.

Atsiskaitymas, pakartojimai ir skirtumas nuo skambintojo ID atnaujinimo

Nauja užklausa gali sukelti užklausos mokestį. Šios užklausų sąsajos nedokumentuoja idempotentiškumo rakto, todėl naujas pakartojimas gali būti antra apmokestinama užklausa. Transporto ar paslaugos gedimų atveju naudokite ribotą atidėjimą (backoff), pirmiausia išspręskite paskyros klaidas ir suderinkite nurodytus užklausų mokesčius. Duomenis laikinojoje atmintyje saugokite tik jūsų programai tinkamą laikotarpį; skambintojo vardo duomenys gali keistis.

CNAM užklausa nuskaito vardą. Ji nekeičia vardo, rodomo jūsų išeinančiuose skambučiuose. LIDB skambintojo vardo atnaujinimas yra atskira operacija su savais laukais, įgaliojimu, kaina ir apdorojimu.

Paskyros CNAM integravimo vadovas Gaukite pagalbos su integracija