Vývojáři

GET/v3/fax_outbox

Výpis odchozích faxových úloh

Načtěte záznamy o svých odchozích faxech a sjednoťte stránkované výsledky bez zadání dalšího přenosu.

Na této stránce
  1. Výpis odchozích faxových úloh
  2. Čtení záznamů úloh
  3. Bezpečné sjednocení stránkovaných výsledků
  4. Ochrana soukromí a opakované pokusy

Výpis odchozích faxových úloh

Použijte aktivovaný účet rozhraní API MultiTEL přes HTTPS s nastavenými přihlašovacími údaji a omezeními IP adres. Tento koncový bod vypisuje záznamy odchozích faxů náležející ověřenému účtu. Výpis fax neodesílá ani znovu neodesílá.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode search=0123456789abcdef0123456789abcdef \
  https://api.multitel.net/v3/fax_outbox
Parametry dotazu pro odchozí faxy
ParametrPovinnýVýznam
pageNeČíslo stránky počínaje 1. Výchozí hodnota: 1.
limitNePočet záznamů na stránku. Výchozí hodnota: 25; maximum: 100. Použijte kladné celé číslo.
searchNeProhledává číslo odesílatele, cílové číslo a UUID úlohy. Mezery na začátku a na konci se odstraňují. Stav ani text výsledku se neprohledávají.

Tato obslužná funkce nepodporuje filtry date_from ani date_to. Přehled odchozích faxů v portálu má další filtry, které by se do tohoto požadavku na rozhraní API neměly přebírat. Výsledky jsou seřazeny podle času vytvoření od nejnovějších, bez druhotného řazení podle ID a bez kurzoru pro neměnný snímek dat.

Čtení záznamů úloh

Čtěte jak výsledek HTTP, tak pole status.code v odpovědi JSON. Úspěšná odpověď obsahuje response.faxes a response.pagination; příklad používá smyšlené údaje. Prázdná schránka vrací prázdné pole faxes s hodnotou total 0 a total_pages 0.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 13,
      "uuid": "0123456789abcdef0123456789abcdef",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "status": "queued",
      "pages_requested": 3,
      "pages_sent": 0,
      "cost": "0.07500",
      "result_text": "",
      "created_at": "2026-10-01 12:00:00",
      "sent_at": null,
      "updated_at": "2026-10-01 12:00:00"
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id je číselný identifikátor záznamu. uuid je viditelný identifikátor úlohy; pro nová odeslání použijte identifikátor úlohy vrácený funkcí send_fax a uchovejte jej pro pravidelné dotazování na stav. Seznam může obsahovat starší záznamy, proto nepředpokládejte, že každý řádek vznikl prostřednictvím stejného koncového bodu pro odesílání.

status a result_text obsahují zaznamenaný stav zpracování a zprávu. Tento výpis je nesjednocuje do úplného výčtu stavů doručení. Zařazení do fronty znamená pouze zařazení do fronty, nikoli doručení. U zásadních dokumentů si u příjemce ověřte přijetí, než budete fax považovat za doručený nebo odešlete jeho duplikát.

pages_requested a pages_sent jsou číselné počty. cost zachovává uloženou hodnotu a jako náhradní hodnotu používá řetězec 0.00; nepředpokládejte, že má stejný datový typ v JSON jako cena příchozího faxu. Záznam ve frontě již může obsahovat odhad. Tato hodnota ani položka v seznamu neurčují konečné vyúčtování.

created_at, sent_at a updated_at jsou uložené hodnoty ve formátu serveru bez posunu časového pásma; sent_at může mít hodnotu null. Seznam neobsahuje pole stavu webhooku, které vrací samostatný koncový bod pro zjištění stavu.

Bezpečné sjednocení stránkovaných výsledků

Řiďte se hodnotami pagination.page, limit, total a total_pages. Stránky za poslední stránkou mohou být prázdné. Nové úlohy mohou během procházení přesouvat položky mezi stránkami. Při slučování stránek uchovávejte identifikátory úloh; tento koncový bod nezaručuje neměnný snímek dat.

Ochrana soukromí a opakované pokusy

Záznamy odchozích faxů obsahují soukromá telefonní metadata. Omezte okruh osob, které je mohou číst, a nezapisujte úplné odpovědi do protokolů. Chybějící položka v seznamu nedokazuje, že požadavek na odeslání selhal: před opětovným odesláním zkontrolujte uchovaný identifikátor úlohy a přehled odchozích faxů v portálu. Nové odeslání může vytvořit další fax, který může být zpoplatněn. Konečné záruky týkající se pracovních procesů, účtování, zpětných volání a uchovávání dat se stále přezkoumávají.