Programeri

GET/v3/cnam/{number}

Dohvat imena pozivatelja

Dohvatite dostupno ime pozivatelja i upoznajte se s cijenama za račun, zamjenskim vrijednostima i ograničenjima ponovnih pokušaja.

Na ovoj stranici
  1. Dohvat imena pozivatelja
  2. Zahtjev
  3. Odgovor
  4. Naplata i usklađivanje evidencije
  5. Pogreške i ponovni pokušaji
  6. Druge operacije s brojevima

Dohvat imena pozivatelja

Dohvatite dostupno ime pozivatelja za telefonski broj. Ovo je upit u produkcijskom okruženju i može teretiti vaš račun, uključujući slučajeve kada rezultat dolazi iz predmemorije usluge. Ne mijenja ime koje se prikazuje pri odlaznim pozivima s broja koji posjedujete.

Vraćeno ime ne potvrđuje identitet, vlasništvo ni dopuštenje za pozivanje. Imena mogu nedostajati, biti zastarjela ili skraćena, biti zemljopisne oznake ili biti zamijenjena telefonskim brojem.

Zahtjev

Upotrijebite svoj omogućeni račun za API s njegove dopuštene izvorne IP adrese. Čuvajte vjerodajnice u spremištu tajni na poslužiteljskoj strani. Primjer upotrebljava varijable okruženja i izmišljeni sjevernoamerički broj; ne stavljajte vjerodajnice u URL-ove ni u javno dostupan kod preglednika.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/cnam/12025550123

Navedite cijeli broj znamenkama, uključujući pozivni broj države, primjerice jedanaest znamenki koje počinju s 1 za Sjevernu Ameriku. Nemojte se oslanjati na to da će obrađivač normalizirati interpunkcijske znakove ili znak plus. Nisu potrebni tijelo zahtjeva ni odabir regije. S MultiTEL-om potvrdite podržanu pokrivenost za namjeravanu uporabu.

Odgovor

Vrijednosti služe samo kao primjer; trošak nije ponuda cijene.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE NAME",
    "cost": 0.0037,
    "balance": 9.9963
  }
}
Polja upita za ime pozivatelja
PoljeZnačenje
numberBroj naveden u zahtjevu.
nameDostupno ime ili zamjenski tekst. To nije provjera identiteta.
costKonfigurirana cijena upita za račun/uslugu koju prijavljuje ovaj tijek obrade. Upotrijebite trenutačnu tarifu računa, a ne vrijednost iz primjera.
balanceStanje izračunato za odgovor. To nije nov transakcijski upit o stanju računa.

Naplata i usklađivanje evidencije

Rezultati koji sadrže ime naplaćuju se po cijeni za CNAM konfiguriranoj za račun. Ponovljeni upit ili upit poslužen iz predmemorije može uzrokovati novu naplatu; ključ idempotentnosti nije dostupan. Provjerite trenutačnu tarifu računa prije omogućivanja automatiziranih upita.

Postoji poznato ograničenje odgovora za prazno ime u predmemoriji: obrađivač može vratiti kod API-ja 200 s praznim imenom, troškom različitim od nule i smanjenim izračunatim stanjem, iako ta grana obrade ne tereti račun. Nemojte sam taj odgovor smatrati dokazom naplate. Uskladite podatke s evidencijom naplate računa i novim rezultatom koji daje upit o stanju računa, a za nejasne rezultate obratite se podršci.

Provjera unaprijed uplaćenih sredstava trenutačno zahtijeva stanje od najmanje 0.004 prije upita, neovisno o konfiguriranoj cijeni po upitu. Odbija se i račun s onemogućenim kupnjama. Te provjere ne čine ovu krajnju točku API-jem za ponude cijena ili ograničavanje potrošnje.

Pogreške i ponovni pokušaji

Provjerite i status HTTP-a i status.code/status.msg u JSON-u. Kod API-ja 403 može značiti nedovoljno unaprijed uplaćenih sredstava, zabranu kupnji, problem s autorizacijom računa ili da ime pozivatelja nije pronađeno. Tijek obrade bez imena može vratiti kod kao niz znakova. Pregledajte poruku umjesto da svaki 403 smatrate neispravnim vjerodajnicama. Sukobi u konfiguraciji mogu vratiti kod API-ja 500.

Prekoračenje vremena može se dogoditi nakon naplativog upita. Upotrebljavajte ograničen broj ponovnih pokušaja s povećavanjem razmaka samo kada to odgovara vašoj aplikaciji i najprije uskladite evidenciju pokušaja s neizvjesnim ishodom. Nemojte stalno ponavljati upite za odbijeni broj ni nakon pogreške povezane s dopuštenjima ili stanjem računa. Predmemorija odgovora u vašoj aplikaciji može smanjiti broj ponovljenih zahtjeva, u skladu s vašim ugovorom i zahtjevima za točnost.

Druge operacije s brojevima

Ova operacija čitanja odvojena je od ažuriranja imena za odlazne pozive/LIDB, unosa u telefonski imenik ili registracije pozivatelja. Te operacije imaju vlastita obvezna polja, zahtjeve za autorizaciju i naknade. Upotrijebite pokrivenost dodjele brojeva za provjeru tablice prefiksa ili pretraživanje brojeva za brojeve dostupne za naručivanje. Ništa od navedenog ne potvrđuje da je pozivatelj osoba za koju se predstavlja.