Programeri

POST/v3/directory/{number}

Pošaljite podatke za upis telefonskog broja u imenik

Pošaljite odobrene podatke za upis u imenik operatera, upoznajte se s implementiranom naplatom i razjasnite neizvjesne rezultate prije ponovnog pokušaja.

Na ovoj stranici
  1. Pošaljite podatke za upis u imenik operatera
  2. Zahtjevi za račun i broj
  3. Zahtjev POST s podacima obrasca
  4. Naplaćivanje i ponovni pokušaji
  5. Odgovor
  6. Pogreške naslijeđene implementacije
  7. Provjerite prije ponovnog pokušaja

Pošaljite podatke za upis u imenik operatera

Pošaljite ime i adresu za upis u imenik za podržani telefonski broj koji posjedujete u sustavu MultiTEL. To je plaćeno ažuriranje kod operatera, a ne dohvat imena pozivatelja, unos u privatni adresar ili opće ažuriranje polja LIDB u evidenciji brojeva na portalu.

Šaljite samo podatke koje je korisnik odobrio za upis u imenik. Prije uporabe ove naslijeđene rute potvrdite da operater podržava taj broj. Pregledani obrađivač ne provjerava je li pružatelj podržan ni međunarodni format broja; zahtjev koji šalje operateru pretpostavlja sjevernoamerički broj i uklanja prvu pohranjenu znamenku.

Zahtjevi za račun i broj

Upotrijebite omogućen račun za API putem protokola HTTPS s dopuštene izvorne IP adrese. Točan broj mora imati zapis kupljenog broja koji nije poništen i koji pripada tom računu. Upotrijebite sve znamenke međunarodnog broja iz svoje evidencije, primjerice format s pozivnim brojem države 1 za podržani sjevernoamerički broj. Nemojte upotrebljavati ID tarifnog plana, UUID broja ni broj koji pripada drugom računu.

Zahtjev POST s podacima obrasca

Postavite NUMBER na broj koji posjedujete. Zamijenite izmišljeni primjer odobrenim podacima za upis. Ova ruta čita polja obrasca iz zahtjeva POST; ne raščlanjuje tijelo u formatu application/json.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode "lastname=EXAMPLE" \
  --data-urlencode "firstname=EXAMPLE" \
  --data-urlencode "streetnum=1" \
  --data-urlencode "streetname=Example" \
  --data-urlencode "streetpredir=N" \
  --data-urlencode "streetpostdir=W" \
  --data-urlencode "city=Example City" \
  --data-urlencode "state=NY" \
  --data-urlencode "postalcode=10001" \
  "https://api.multitel.net/v3/directory/$NUMBER"
Polja obrasca za upis u imenik
PoljeObvezno za ovaj APIZnačenje
lastnameDaPrezime za upis ili odgovarajuće polje naziva za upis.
cityDaGrad za upis.
postalcodeDaPoštanski broj za upis.
stateDaSavezna država ili regija za upis koju podržani operater prihvaća.
streetnameDaNaziv ulice.
streetnumDaKućni broj.
firstnameNeDodatna sastavnica osobnog imena.
streetpredir, streetpostdirNeOznake smjera prije i poslije naziva ulice, kada su primjenjive.
streettype, locationNeVrsta ulice ili dodatni opis lokacije, kada je primjenjivo.

Oznake smjera i adresa u primjeru služe kao ogledni podaci, a ne kao preporučena poštanska adresa. Nemojte dodavati izmišljenu oznaku smjera stvarnim podacima korisnika. Provjere obveznih polja koje provodi API površne su: ne utvrđuju je li adresa valjana ni prihvaća li je operater, a staro web-mjesto primjenjivalo je drukčije zahtjeve za obrazac.

Implementacija može ispisati upozorenje o nedostajućem ključu polja kada neobvezna oznaka smjera nedostaje ili je prazna. Ako je odgovor neispravno oblikovan ili operater odbije adresu, sačuvajte referencu zahtjeva i zatražite od podrške da potvrdi upis umjesto da opetovano šaljete izmijenjene pretpostavke o adresi.

Naplaćivanje i ponovni pokušaji

Pregledani obrađivač provjerava iznosi li saldo najmanje 10.00 jedinica salda prije kontaktiranja operatera. Nakon što i operater i lokalno ažuriranje broja prijave uspjeh, oduzima 10.00 sa salda računa i bilježi transakciju uspostave upisa u imenik. To su trenutačno implementirani iznosi, a ne novi prijedlog cijena; prije slanja provjerite primjenjivu valutu naplate i podržanu uslugu u uvjetima svojeg računa.

Operacija nema ključ idempotentnosti, zaštitu od dvostrukih narudžbi ni transakciju koja obuhvaća slanje operateru, lokalno ažuriranje i naplatu. Uspješan ponovljeni zahtjev može uzrokovati ponovno slanje operateru i novu naplatu. Istek vremena čekanja ili pogreška sučelja API ne dokazuju da je operater odbio prethodni zahtjev: pružatelj ga je možda prihvatio prije nego što je lokalno ažuriranje završilo neuspjehom.

Odgovor

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": ""
}

Uobičajeni odgovor pri uspjehu sadrži prazan niz znakova u polju response i ne vraća ID upisa ni pojedinosti o dovršetku. To znači da su i postupak kod operatera i lokalno ažuriranje prijavili uspjeh; ne dokazuje objavu u svakom vanjskom imeniku, trenutačno širenje podataka ni budući prikaz identiteta pozivatelja.

Pogreške naslijeđene implementacije

Kodovi rezultata sučelja API za upis u imenik
Kod sučelja APIZnačenje
404Broj nije pronađen na računu ili je jedno od obveznih polja obrasca bilo prazno.
400Saldo računa manji je od implementiranog iznosa naplate.
500Zahtjev operateru nije uspio ili lokalno ažuriranje nije uspjelo nakon što je operater možda već prihvatio zahtjev.
200Prijavljen je uspjeh; odgovor ne sadrži potvrdu objave.

Pročitajte i status protokola HTTP i sljedeća polja u formatu JSON: status.code/status.msg. Autentifikacija i ograničenja izvornih IP adresa također mogu spriječiti dobivanje upotrebljivog odgovora. Nemojte upotrebljavati GET ni parametre upita za traženje ažuriranja samo zato što naslijeđeni obrađivač nema izričitu provjeru metode protokola HTTP.

Provjerite prije ponovnog pokušaja

  1. Prije slanja zahtjeva potvrdite broj koji posjedujete, podržanost kod operatera, odobrene podatke za upis i iznos naplate.
  2. Pošaljite zahtjev jednom i sačuvajte rezultat na strani računa bez otkrivanja korisnikove adrese u javnim zapisnicima ili analitičkim podacima.
  3. Provjerite spremljeni upis i povijest transakcija putem podržanog postupka za račun ili korisničke podrške. Pričekajte vrijeme obrade koje je operater potvrdio; ovaj API ne određuje zajamčeni rok širenja podataka.
  4. Ako je rezultat neizvjestan, zatražite od podrške da uskladi narudžbu kod operatera i lokalnu naplatu prije ponovnog pokušaja. Ponovljeni zahtjev nije idempotentna provjera statusa.