Saabunud fakside loend

Saabunud fakside loend

Kasutage aktiveeritud MultiTEL API kontot HTTPS kaudu koos kontole seadistatud pääsuandmete ja IP-piirangutega. See lõpp-punkt loetleb autenditud kontole kuuluvad saabunud faksid. See ei saada faksi ega laadi alla selle dokumenti.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox

Kuupäevapiirid on kaasavad ja lähtuvad API serveri kuupäevatõlgendusest, mitte päringus soovitud kasutaja ajavööndist. Vigased kuupäevastringid võidakse tagasilükkamise asemel eirata; kontrollige nende kehtivust enne saatmist. Kuupäevafiltrite puudumisel ei rakenda päringutöötleja vaikimisi kuupäevavahemikku. Tulemused järjestatakse vastuvõtuaja järgi, uusimad eespool. Lõpp-punkt ei taga eri lehekülgede jaoks muutumatut andmete hetktõmmist: uued saabunud faksid võivad nihutada kirjeid lehekülgede vahel.

Postkasti lehekülje lugemine

Kontrollige HTTP tulemust ja JSON välja status.code. Mujal API liideses esinevate tõrgete korral võidakse kasutada JSON veavastuse struktuuri ka siis, kui HTTP olekukood on 200. Edukas vastus sisaldab välju response.faxes ja response.pagination. Selles näites kasutatakse väljamõeldud väärtusi.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id on sisendkausta kirje numbriline identifikaator. hash on selle MD5 esitus varasema sissetulevate dokumentide töövoo jaoks; see ei ole send_fax töö identifikaator ega autoriseerimiseks kasutatav pääsuandmestik. Ärge kasutage seda väljaminevate fakside fax_status lõpp-punktiga.

received_timestamp on salvestatud Unixi ajatempel. received_at on serveri vormindatud ajatempel ilma ajavööndi nihketa või null, kui vastuvõtuaega pole salvestatud; oma ajavööndis kellaaegade kuvamiseks kasutage Unixi väärtust. cost on JSON arv, mitte hinnapakkumine ega tõend eraldi tehtud tasu võtmise kohta.

status väärtus on success ainult siis, kui salvestatud olekukood on null; muude väärtuste korral saab selle väärtuseks failed. status_text sisaldab salvestatud töötlusteadet; selle puudumisel kasutatakse väärtust OK või Failed. emailed säilitab salvestatud väärtuse ega teisenda seda tõeväärtuseks. viewed on tõeväärtus. Ärge järeldage e-kirja edukat kohaletoimetamist üksnes faksi oleku põhjal.

Tühjade ja muutuvate loendite käsitlemine

Tühi postkast tagastab tühja massiivi faxes, välja total väärtusega 0 ja välja total_pages väärtusega 0. Ka viimasest leheküljest suurema numbriga lehekülg võib tagastada tühja massiivi. Lõpetage lehekülgede lugemine lehekülgedeks jaotuse väljade alusel, mitte eeldusel, et vähemalt üks lehekülg on alati olemas. Kursorit ega teisest järjestust kirje identifikaatori järgi ei pakuta. Säilitage kirjete identifikaatorid, kui ühildate kattuvate lehekülgede andmeid.

Juurdepääs dokumentidele ja privaatsus

Postkasti kirjed sisaldavad privaatseid telefoni- ja dokumendimetaandmeid. Piirake oma rakenduses juurdepääsu ja vältige terviklike vastuste logimist. Loendi pärimine ei märgi dokumenti vaadatuks. Kasutage fax_file varasema töövooga ühilduvaks sissetulevate dokumentide allalaadimiseks, arvestades, et see märgib olemasoleva sissetuleva faksi kirje vaadatuks ka siis, kui selle fail pole saadaval. Dokumentidele pääseb ligi ka portaali sisendkausta kaudu. Failide säilitamise garantiid ei ole kehtestatud.