Fejlesztők

GET/v3/fax_inbox

Beérkezett faxok listázása

A bejövő faxok postafiókjának lekérdezése lapozással, telefonszám szerinti kereséssel és a beérkezés dátuma szerinti szűréssel.

Ezen az oldalon
  1. Beérkezett faxok listázása
  2. A postafiók egy oldalának lekérdezése
  3. Üres és változó listák kezelése
  4. Dokumentumhozzáférés és adatvédelem

Beérkezett faxok listázása

Használjon engedélyezett MultiTEL API-fiókot HTTPS-kapcsolaton keresztül, a fiókhoz beállított hitelesítési adatokkal és IP-korlátozásokkal. Ez a végpont a hitelesített fiókhoz tartozó beérkezett faxokat listázza. Nem küld faxot, és nem tölti le annak dokumentumát.

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
A bejövő postafiók lekérdezési paraméterei
ParaméterKötelezőJelentés
pageNemOldalszám, 1 kezdőértékkel. Alapértelmezett érték: 1.
limitNemRekordok száma oldalanként. Alapértelmezett érték: 25; maximum: 100. Pozitív egész számot adjon meg.
searchNemA küldő telefonszámában, a fogadó faxszámban és a távoli állomás azonosítójában keres. A kezdő és záró szóközöket eltávolítja. A kis- és nagybetűk megkülönböztetése az adatbázis karakter-összehasonlítási szabályaitól függ.
date_fromNemA kiszolgáló helyi ideje szerinti megadott nap kezdetétől beérkezett faxokat tartalmazza. Használja a YYYY-MM-DD formátumot.
date_toNemA kiszolgáló helyi ideje szerinti megadott nap végéig beérkezett faxokat tartalmazza. Használja a YYYY-MM-DD formátumot.

A dátumhatárok a határnapokat is magukban foglalják, és az API-kiszolgáló dátumértelmezését használják, nem pedig a felhasználó által kért időzónát. Az érvénytelen dátumszövegeket a rendszer elutasítás helyett figyelmen kívül hagyhatja; küldés előtt ellenőrizze az érvényességüket. Dátumszűrők nélkül a kéréskezelő nem alkalmaz alapértelmezett dátumtartományt. A találatok a beérkezés ideje szerint rendezve jelennek meg, a legújabbakkal kezdve. A végpont nem biztosít változatlan pillanatképet az oldalak között: az újonnan beérkező faxok miatt a rekordok másik oldalra kerülhetnek.

A postafiók egy oldalának lekérdezése

Ellenőrizze a HTTP eredményét és a JSON-válasz status.code mezőjét. Az API más részein fellépő hibák JSON hibaburkolatban is megjelenhetnek, még akkor is, ha a HTTP-állapot 200. A sikeres válasz tartalmazza a response.faxes és a response.pagination mezőt. Ez a példa kitalált értékeket használ.

{
  "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 a bejövő postafiók rekordjának numerikus azonosítója. hash ennek MD5 szerinti ábrázolása a bejövő dokumentumok régi munkafolyamatához; nem a send_fax feladatazonosítója, és nem jogosultságot igazoló hitelesítési adat. Ne használja a kimenő faxokhoz tartozó fax_status végponttal.

received_timestamp a tárolt Unix-időbélyeg. received_at a kiszolgáló által formázott, időzóna-eltolás nélküli időbélyeg, vagy null, ha nincs rögzített beérkezési idő; a saját időzónájában történő megjelenítéshez használja a Unix-értéket. cost egy JSON-szám, nem árajánlat, és nem igazolja külön díj tényleges felszámítását.

status értéke csak akkor success, ha a tárolt állapotkód nulla; minden más érték esetén failed lesz. status_text a tárolt feldolgozási üzenetet tartalmazza, ennek hiányában OK vagy Failed értékkel. emailed a tárolt értéket őrzi meg, nem logikai értéket ad vissza. viewed logikai érték. Ne következtessen sikeres e-mail-kézbesítésre kizárólag a fax állapotából.

Üres és változó listák kezelése

Üres postafiók esetén üres faxes tömb érkezik vissza, a total értéke 0, a total_pages értéke pedig 0. Az utolsó oldal utáni oldal lekérdezése is visszaadhat üres tömböt. A lapozási mezők alapján állítsa le a lekérdezést, ne feltételezze, hogy legalább egy oldal létezik. Sem kurzor, sem rekordazonosító szerinti másodlagos rendezés nem érhető el. Az átfedő oldalak egyeztetésekor őrizze meg a rekordazonosítókat.

Dokumentumhozzáférés és adatvédelem

A postafiók bejegyzései bizalmas telefonos és dokumentum-metaadatokat tartalmaznak. Korlátozza a hozzáférést az alkalmazásában, és kerülje a teljes válaszok naplózását. A listázás nem jelöli megtekintettként a dokumentumot. Használja a fax_file végpontot a bejövő dokumentumok kompatibilitási célú letöltéséhez; vegye figyelembe, hogy ez akkor is megtekintettként jelöl egy meglévő bejövő rekordot, ha a fájlja nem érhető el. A dokumentumok a portál bejövő postafiókjából is elérhetők. A fájlok megőrzésére nincs rögzített garancia.