Arendajad

GET/v3/fax_outbox

Väljaminevate faksitööde loend

Vaadake väljaminevate fakside kirjeid ja koondage tulemuste lehekülgi ilma uut saatmistaotlust esitamata.

Sellel lehel
  1. Väljaminevate faksitööde loend
  2. Töökirjete lugemine
  3. Tulemuste lehekülgede turvaline koondamine
  4. Privaatsus ja korduskatsed

Väljaminevate faksitööde loend

Kasutage aktiveeritud MultiTEL API kontot koos sellele seadistatud autentimisandmete ja IP-piirangutega ning looge ühendus protokolli HTTPS kaudu. See lõpp-punkt loetleb autenditud kontole kuuluvad väljaminevate fakside kirjed. Loendi pärimine ei saada faksi ega saada seda uuesti.

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
Väljaminevate fakside päringu parameetrid
ParameeterKohustuslikTähendus
pageEiLehekülje number, alustades arvust 1. Vaikeväärtus: 1.
limitEiKirjete arv leheküljel. Vaikeväärtus: 25; suurim lubatud väärtus: 100. Kasutage positiivset täisarvu.
searchEiOtsib saatja numbri, saaja numbri ja töö UUID järgi. Algus- ja lõputühikud eemaldatakse. Oleku ega tulemuse teksti hulgast ei otsita.

See päringutöötleja ei toeta filtreid date_from ega date_to. Portaali väljaminevate fakside vaates on lisafiltrid, mida ei tohiks sellesse API päringusse kopeerida. Tulemused järjestatakse loomisaja järgi, uusimad eespool, ilma täiendava tunnuse järgi sortimise või hetktõmmise kursorita.

Töökirjete lugemine

Kontrollige nii HTTP tulemust kui ka JSON välja status.code. Õnnestunud vastus sisaldab välju response.faxes ja response.pagination; näites kasutatakse väljamõeldud andmeid. Tühja postkasti korral tagastatakse tühi faxes massiiv, kus total väärtus on 0 ja total_pages väärtus on 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 on kirje arvuline tunnus. uuid on töö nähtav tunnus; uute saatmistaotluste puhul kasutage töö tunnust, mille tagastab send_fax, ning säilitage see, et teha perioodilisi olekupäringuid. Loend võib sisaldada vanemaid kirjeid, seega ärge eeldage, et kõik read loodi sama saatmise lõpp-punkti kaudu.

status ja result_text sisaldavad salvestatud töötlusolekut ja teadet. See loend ei teisenda neid ühtseks täielikuks kohaletoimetamisolekute loendiks. Järjekorras tähendab järjekorras olemist, mitte kohaletoimetamist. Oluliste dokumentide puhul kinnitage saajaga kättesaamine, enne kui loete faksi kohaletoimetatuks või esitate duplikaadi.

pages_requested ja pages_sent on arvulised kogused. cost säilitab salvestatud väärtuse, kasutades varuväärtusena stringi 0.00; ärge eeldage, et selle JSON andmetüüp on sama mis sissetuleva faksi maksumusel. Järjekorras olev kirje võib juba sisaldada hinnangulist maksumust. See väärtus ega kirje olemasolu loendis ei kinnita lõplikku arveldust.

created_at, sent_at ja updated_at on salvestatud serveri vormingus väärtused ilma ajavööndi nihketa; sent_at väärtus võib olla null. Loend ei sisalda veebikonksu oleku välja, mille tagastab eraldi oleku lõpp-punkt.

Tulemuste lehekülgede turvaline koondamine

Lähtuge väljade pagination.page, limit, total ja total_pages väärtustest. Viimasele leheküljele järgnevad leheküljed võivad olla tühjad. Uued tööd võivad sirvimise ajal kirjeid lehekülgede vahel nihutada. Lehekülgede koondamisel säilitage tööde tunnused; see lõpp-punkt ei taga muutumatut hetktõmmist.

Privaatsus ja korduskatsed

Väljaminevate fakside kirjed sisaldavad privaatseid telefonimetaandmeid. Piirake nende lugemisõigust ja vältige täielike vastuste logimist. Kirje puudumine loendist ei tõenda saatmistaotluse nurjumist: enne uuesti esitamist kontrollige säilitatud töö tunnust ja portaali väljaminevate fakside vaadet. Uus saatmine võib luua veel ühe faksi, mille eest võidakse tasu võtta. Lõplikud tagatised taustatöötluse, arvelduse, tagasikutsete ja andmete säilitamise kohta on endiselt ülevaatamisel.