Listaa vastaanotetut faksit

Listaa vastaanotetut faksit

Käytä käytössä olevaa MultiTEL API -tiliä HTTPS-yhteydellä sekä tilille määritettyjä tunnistetietoja ja IP-rajoituksia. Tämä päätepiste listaa todennetulle tilille kuuluvat vastaanotetut faksit. Se ei lähetä faksia eikä lataa sen asiakirjaa.

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

Päivämäärärajat sisältyvät aikaväliin, ja niissä käytetään API-palvelimen päivämäärätulkintaa, ei pyydettyä käyttäjän aikavyöhykettä. Virheelliset päivämäärämerkkijonot saatetaan ohittaa hylkäämisen sijaan; tarkista niiden kelvollisuus ennen lähettämistä. Ilman päivämääräsuodattimia käsittelijä ei aseta oletusarvoista aikaväliä. Tulokset järjestetään vastaanottoajan mukaan uusimmat ensin. Päätepiste ei tarjoa sivujen välillä muuttumatonta tilannekuvaa: uudet saapuvat faksit voivat siirtää tietueita sivulta toiselle.

Lue postilaatikon sivu

Lue HTTP-tulos ja JSON-vastauksen status.code. Muualla API-rajapinnassa ilmenevät virheet voidaan palauttaa JSON-muotoisessa virherakenteessa, vaikka HTTP-tilakoodi olisi 200. Onnistunut vastaus sisältää kentät response.faxes ja response.pagination. Tässä esimerkissä käytetään kuvitteellisia arvoja.

{
  "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 saapuneiden kansion tietueen numeerinen tunniste. hash on sen MD5-esitys saapuvien asiakirjojen vanhaa työnkulkua varten; se ei ole send_fax-työn tunniste eikä käyttöoikeuden antava tunnistetieto. Älä käytä sitä lähtevien faksien fax_status-päätepisteen kanssa.

received_timestamp on tallennettu Unix-aikaleima. received_at on palvelimen muotoilema aikaleima ilman aikavyöhykepoikkeamaa tai null, jos vastaanottoaikaa ei ole tallennettu; käytä Unix-arvoa, kun näytät ajat omalla aikavyöhykkeelläsi. cost on JSON-luku, ei hintatarjous eikä todiste erillisestä toteutuneesta veloituksesta.

status on success vain, kun tallennettu tilakoodi on nolla; muilla arvoilla tulokseksi tulee failed. status_text sisältää tallennetun käsittelyviestin; varalla käytetään arvoa OK tai Failed. emailed säilyttää tallennetun arvon totuusarvon sijaan. viewed on totuusarvo. Älä päättele sähköpostin toimituksen onnistuneen pelkästään faksin tilan perusteella.

Käsittele tyhjiä ja muuttuvia listoja

Tyhjä postilaatikko palauttaa tyhjän faxes-taulukon sekä kentät total arvolla 0 ja total_pages arvolla 0. Myös viimeisen sivun jälkeinen sivu voi palauttaa tyhjän taulukon. Lopeta haku sivutuskenttien perusteella sen sijaan, että olettaisit sivuja olevan vähintään yksi. Kohdistinta tai toissijaista järjestystä tietuetunnisteen mukaan ei ole saatavilla. Säilytä tietueiden tunnisteet, kun täsmäytät päällekkäisiä sivuja.

Asiakirjojen käyttö ja yksityisyys

Postilaatikon tietueet sisältävät yksityisiä puhelin- ja asiakirjametatietoja. Rajoita pääsyä sovelluksessasi ja vältä kokonaisten vastausten kirjaamista lokiin. Listaaminen ei merkitse asiakirjaa katsotuksi. Käytä toimintoa fax_file saapuvien asiakirjojen yhteensopivuuslataukseen. Huomaa, että se merkitsee olemassa olevan saapuvan tietueen katsotuksi, vaikka sen tiedosto ei olisi saatavilla. Asiakirjoja voi käyttää myös portaalin saapuneiden kansion kautta. Tiedostojen säilyttämiselle ei ole vahvistettu takuuta.