Telefoninumbri kirje esitamine telefonikataloogi

Kirje esitamine operaatori telefonikataloogi

Esitage nimi ja aadress, mida kasutada telefonikataloogi kirjes sobiva telefoninumbri jaoks, mis kuulub teile MultiTEL-is. See on tasuline uuendus operaatori juures, mitte helistaja nime otsing, isikliku aadressiraamatu kirje ega portaali numbriloendi välja LIDB üldine uuendus.

Esitage ainult andmed, mille avaldamiseks telefonikataloogis on klient loa andnud. Enne selle pärandmarsruudi kasutamist veenduge, et operaator toetab kõnealust numbrit. Ülevaadatud päringutöötleja ei kontrolli teenusepakkuja sobivust ega numbri rahvusvahelist vormingut; operaatorile saadetav päring eeldab Põhja-Ameerika numbrit ja eemaldab esimese salvestatud numbri.

Konto ja numbri nõuded

Kasutage lubatud lähte-IP-aadressilt aktiveeritud API kontot HTTPS kaudu. Täpne number peab vastama sellele kontole kuuluvale tühistamata ostetud numbri andmereale. Kasutage oma numbriloendis olevat täielikku rahvusvahelist numbrikuju, näiteks toetatud Põhja-Ameerika numbri puhul vormingut riigikoodiga 1. Ärge kasutage hinnapaketi ID-d, numbri UUID tunnust ega teisele kontole kuuluvat numbrit.

Vormi POST-päring

Määrake NUMBER väärtuseks teile kuuluv number. Asendage väljamõeldud näide kliendi loal esitatavate kirjeandmetega. See marsruut loeb vormivälju POST-päringust; see ei parsi application/json-vormingus päringukeha.

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"

Telefonikataloogi kirje vormiväljad
Väli	Selle API puhul kohustuslik	Tähendus
lastname	Jah	Kirjes kasutatav perekonnanimi või asjakohane kirje nimeväli.
city	Jah	Kirjes kasutatav linn.
postalcode	Jah	Kirjes kasutatav sihtnumber.
state	Jah	Kirjes kasutatav osariik või piirkond, mida toetatud operaator aktsepteerib.
streetname	Jah	Tänava nimi.
streetnum	Jah	Majanumber.
firstname	Ei	Täiendav eesnimeosa.
streetpredir, streetpostdir	Ei	Ilmakaare tähised tänavanime ees ja järel, kui need on asjakohased.
streettype, location	Ei	Tänava liik või asukoha lisakirjeldus, kui see on asjakohane.

Näites kasutatud ilmakaared ja aadress on kohatäited, mitte soovitatav postiaadress. Ärge lisage tegelikele kliendiandmetele väljamõeldud ilmakaart. API kohustuslike väljade kontrollid on pealiskaudsed: need ei kinnita, et aadress on kehtiv või operaatorile vastuvõetav, ning pärandveebisaidil kehtisid vormile teistsugused nõuded.

Teostus võib väljastada puuduva massiivivõtme hoiatuse, kui valikuline ilmakaaretähis puudub või on tühi. Kui vastus on vigase vorminguga või operaator lükkab aadressi tagasi, säilitage päringu viide ja paluge klienditoel kirje kinnitada, selle asemel et korduvalt oletuste põhjal muudetud aadresse esitada.

Tasu arvestamine ja korduskatsete käitumine

Ülevaadatud päringutöötleja kontrollib, et kontol oleks vähemalt 10.00 saldoühikut enne operaatoriga ühenduse võtmist. Kui nii operaator kui ka numbri kohalik uuendus on teatanud õnnestumisest, arvab see maha 10.00 konto saldost ja salvestab telefonikataloogi kirje seadistamise tehingu. Need on praegu teostuses kasutatavad summad, mitte uus hinnapakkumine; enne esitamist kontrollige oma konto tingimustest kohaldatavat arveldusvaluutat ja toetatud teenust.

Toimingul puudub idempotentsusvõti, kaitse topelttellimuste eest ning operaatorile esitamist, kohalikku uuendust ja arveldamist hõlmav ühine transaktsioon. Õnnestunud korduspäring võib põhjustada uue esitamise operaatorile ja uue tasu. Ajalõpp või API viga ei tõenda, et operaator lükkas eelmise päringu tagasi: teenusepakkuja võis selle vastu võtta enne kohaliku uuenduse nurjumist.

Vastus

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

Tavalises õnnestunud vastuses on tühja stringi väärtusega väli response ning kirje ID-d ega lõpuleviimise üksikasju ei tagastata. See tähendab, et operaatori ja kohaliku uuenduse töötlusteed teatasid õnnestumisest; see ei tõenda avaldamist igas välises telefonikataloogis, kohest levikut ega edaspidist helistaja identifikaatori kuvamist.

Pärandsüsteemi vead

Telefonikataloogi kirjete API tulemuskoodid
API kood	Tähendus
404	Numbrit ei leitud kontolt või mõni kohustuslik vormiväli oli tühi.
400	Konto saldo on väiksem kui teostuses rakendatud tasu.
500	Operaatorile saadetud päring nurjus või kohalik uuendus nurjus pärast seda, kui operaator võis päringu juba vastu võtta.
200	Teatati õnnestumisest; vastus ei sisalda avaldamise kinnitust.

Kontrollige nii HTTP olekut kui ka JSON välju status.code/status.msg. Ka autentimine ja lähte-IP piirangud võivad takistada kasutatava vastuse saamist. Ärge kasutage uuenduse taotlemiseks GET-meetodit ega päringuparameetreid pelgalt seetõttu, et päringute pärandtöötlejal puudub sõnaselge HTTP-meetodi kontroll.

Kontrollige enne uut katset

Enne päringu saatmist kontrollige teile kuuluvat numbrit, operaatori sobivust, kliendi loal esitatavaid kirjeandmeid ja tasu.
Esitage päring üks kord ja säilitage kontopoolne tulemus, avaldamata kliendi aadressi avalikes logides või analüütikas.
Kontrollige salvestatud kirjet ja tehinguajalugu toetatud konto töövoo või klienditoe kaudu. Arvestage operaatori kinnitatud töötlusajaga; see API ei määra garanteeritud levikutähtaega.
Kui tulemus on ebaselge, laske klienditoel enne uut katset operaatori tellimus ja kohalik arveldus omavahel kooskõlla viia. Korduspäring ei ole idempotentne olekukontroll.