Seznam přijatých faxů

Seznam přijatých faxů

Použijte aktivovaný účet MultiTEL API přes HTTPS s nakonfigurovanými přihlašovacími údaji a omezeními IP adres. Tento koncový bod vypisuje přijaté faxy patřící ověřenému účtu. Neodesílá fax ani nestahuje jeho dokument.

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

Krajní data jsou zahrnuta a vykládají se podle serveru API, nikoli podle požadovaného časového pásma uživatele. Neplatné řetězce s datem mohou být ignorovány místo odmítnutí; před odesláním ověřte jejich platnost. Bez filtrů data obslužná rutina neuplatňuje žádné výchozí časové období. Výsledky jsou seřazeny podle času přijetí, od nejnovějších. Koncový bod neposkytuje neměnný snímek napříč stránkami: nově přijaté faxy mohou přesouvat záznamy mezi stránkami.

Načtení stránky schránky

Zkontrolujte výsledek HTTP a hodnotu status.code ve formátu JSON. Chyby v jiných částech API mohou být vráceny v chybové obálce JSON, i když je stav HTTP 200. Úspěšná odpověď obsahuje response.faxes a response.pagination. Tento příklad používá smyšlené hodnoty.

{
  "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 je číselný identifikátor záznamu ve schránce příchozích faxů. hash je jeho reprezentace MD5 pro původní postup práce s příchozími dokumenty; nejde o identifikátor úlohy send_fax ani o autorizační údaj. Nepoužívejte jej s koncovým bodem pro odchozí faxy fax_status.

received_timestamp je uložené unixové časové razítko. received_at je časové razítko formátované serverem bez posunu časového pásma, nebo null, pokud čas přijetí není zaznamenán; při zobrazování časů ve vlastním časovém pásmu použijte unixovou hodnotu. cost je číslo ve formátu JSON, nikoli cenová nabídka ani doklad o samostatném dokončeném naúčtování.

status má hodnotu success pouze tehdy, je-li uložený stavový kód roven nule; ostatní hodnoty se převádějí na failed. status_text obsahuje uloženou zprávu o zpracování; pokud chybí, použije se OK nebo Failed. emailed zachovává uloženou hodnotu, místo aby ji převádělo na logickou hodnotu. viewed je logická hodnota. Ze samotného stavu faxu nevyvozujte, že byl e-mail úspěšně doručen.

Práce s prázdnými a měnícími se seznamy

Prázdná schránka vrací prázdné pole faxes, total 0 a total_pages 0. Požadavek na stránku za poslední stránkou může také vrátit prázdné pole. Načítání ukončujte podle polí stránkování a nepředpokládejte, že existuje alespoň jedna stránka. Není zpřístupněn kurzor ani druhotné řazení podle identifikátoru záznamu. Při slučování překrývajících se stránek uchovávejte identifikátory záznamů.

Přístup k dokumentům a ochrana soukromí

Záznamy ve schránce obsahují soukromá metadata o telefonních číslech a dokumentech. Omezte přístup ve své aplikaci a nezapisujte do protokolů úplné odpovědi. Vypsání seznamu neoznačí dokument jako zobrazený. Použijte fax_file pro stažení příchozího dokumentu v režimu kompatibility; mějte na paměti, že existující záznam příchozího faxu označí jako zobrazený, i když jeho soubor není dostupný. K dokumentům lze přistupovat také prostřednictvím schránky příchozích faxů v portálu. Nebyla stanovena žádná záruka uchovávání souborů.