Gautų faksų sąrašas

Gautų faksų sąrašas

Naudokite įgalintą MultiTEL API paskyrą per HTTPS su jai sukonfigūruotais prisijungimo duomenimis ir IP apribojimais. Šis galinis taškas pateikia autentifikuotai paskyrai priklausančių gautų faksų sąrašą. Jis nesiunčia fakso ir neatsisiunčia jo dokumento.

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

Datos ribos įtraukiamos ir interpretuojamos pagal API serverio datos taisykles, o ne pagal užklausoje nurodytą naudotojo laiko juostą. Netinkamos datos eilutės gali būti ignoruojamos, užuot jas atmetus; prieš siųsdami patikrinkite jų tinkamumą. Jei datos filtrai nenurodyti, apdorojimo programa netaiko jokio numatytojo datų intervalo. Rezultatai rikiuojami pagal gavimo laiką, naujausi pateikiami pirmiausia. Galinis taškas neužtikrina nekintančios duomenų momentinės kopijos visuose puslapiuose: dėl naujai gautų faksų įrašai gali persikelti iš vieno puslapio į kitą.

Skaitykite gautų faksų dėžutės puslapį

Patikrinkite HTTP rezultatą ir JSON lauką status.code. Kitur API klaidos gali būti pateikiamos JSON klaidos struktūroje net tada, kai HTTP būsenos kodas yra 200. Sėkmingame atsakyme yra response.faxes ir response.pagination. Šiame pavyzdyje naudojamos išgalvotos reikšmės.

{
  "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 yra skaitinis gautų faksų dėžutės įrašo identifikatorius. hash yra jo MD5 atvaizdis, skirtas senajai gaunamų dokumentų darbo eigai; tai nėra send_fax užduoties identifikatorius ar prieigos suteikimo duomuo. Nenaudokite jo su siunčiamų faksų fax_status galiniu tašku.

received_timestamp yra išsaugota Unix laiko žyma. received_at yra serverio suformatuota laiko žyma be laiko juostos poslinkio arba null, jei gavimo laikas neužregistruotas; rodydami laiką savo laiko juostoje naudokite Unix reikšmę. cost yra JSON skaičius, o ne kainos pasiūlymas ar įrodymas, kad atskiras mokestis jau nuskaitytas.

status reikšmė yra success tik tada, kai išsaugotas būsenos kodas lygus nuliui; kitais atvejais reikšmė tampa failed. status_text pateikia išsaugotą apdorojimo pranešimą; jei jo nėra, naudojama OK arba Failed. emailed išlaiko išsaugotą reikšmę, o ne loginę reikšmę. viewed yra loginė reikšmė. Nespręskite apie sėkmingą el. laiško pristatymą vien pagal fakso būseną.

Tvarkykite tuščius ir kintančius sąrašus

Kai gautų faksų dėžutė tuščia, grąžinamas tuščias faxes masyvas, total reikšmė 0 ir total_pages reikšmė 0. Užklausus puslapio, esančio už paskutinio puslapio, taip pat gali būti grąžintas tuščias masyvas. Baikite skaityti pagal puslapiavimo laukus, o ne darydami prielaidą, kad yra bent vienas puslapis. Nei žymeklis, nei antrinis rikiavimas pagal įrašo identifikatorių nepateikiamas. Derindami persidengiančių puslapių duomenis išsaugokite įrašų identifikatorius.

Prieiga prie dokumentų ir privatumas

Gautų faksų dėžutės įrašuose yra privačių telefono ir dokumentų metaduomenų. Apribokite prieigą savo programoje ir venkite registruoti visus atsakymus žurnaluose. Sąrašo gavimas nepažymi dokumento kaip peržiūrėto. Naudokite fax_file suderinamumui užtikrinti skirtam gauto dokumento atsisiuntimui; atkreipkite dėmesį, kad ši funkcija pažymi esamą gauto fakso įrašą kaip peržiūrėtą net tada, kai jo failas nepasiekiamas. Dokumentus taip pat galima pasiekti portalo gautų faksų dėžutėje. Failų saugojimo garantija nenustatyta.