Laadige alla sisend- või väljundkausta faks

Valige sissetulev või väljaminev dokument

See ühilduvust tagav lõpp-punkt hangib teie kontole kuuluva faksidokumendi. Kasutage aktiveeritud MultiTEL API kontot HTTPS kaudu koos sellele seadistatud autentimisandmete ja IP-piirangutega. See ei saada faksi ega saada seda uuesti.

Need väärtused tuleb lisada teesse. Marsruut on /v3/fax_file/{type}/{id}, mitte fax_download koos täiendavate teesegmentidega. Sissetuleva faksi räsiväärtus ei ole kirje numbriline ID ega väljamineva töö ID. Kopeerige identifikaator vastava postkasti loendist; see ei asenda autentimist.

Laadige alla vastuvõetud faks

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710

Näite räsiväärtus tähistab väljamõeldud sisendkausta kirjet 12. Enda kirje väärtuse saamiseks kasutage fax_inbox. Olemasoleva sissetuleva kirje allalaadimine märgib selle vaadatuks. See toimub enne faili kättesaadavuse kontrollimist, mistõttu võib välja viewed väärtuseks jääda true ka siis, kui tagastatakse faili puudumise viga. Ärge kasutage seda lõpp-punkti üksnes vastuvõetud faksi olemasolu kontrollimiseks, kui soovite selle vaatamisoleku muutmata jätta.

Töötleja eelistab salvestatud PDF faili. Vastasel juhul kasutab see salvestatud TIFF faili ja proovib selle teisendada vormingusse PDF, kui teisendaja on saadaval. Kui teisendamine pole saadaval või tekitab käsitletud erindi, tagastatakse selle asemel TIFF fail. Kontrollige alati tagastatud päist Content-Type, selle asemel et eeldada vormingut PDF.

Laadige alla väljaminev faks

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdef

Kasutage välja uuid, mille tagastab fax_outbox. See ühilduvust tagav allalaadimine eelistab esmalt salvestatud PDF binaarandmeobjekti, seejärel TIFF binaarandmeobjekti ning seejärel saadaolevat PDF faili, TIFF faili või algset lähtefaili. Selle eelistusjärjekord erineb praeguse väljaminevate fakside fax_download töötleja omast. Uute integratsioonide puhul, mis kasutavad send_fax, kasutage seda praegust allalaadimise töövoogu koos selle parameetriga job_id.

Algne lähtefail võidakse tagastada tüübiga application/octet-stream, mitte vormingus PDF või TIFF. Manuse failinimes võib säilida lähtefaili laiend. Ühilduvust tagav väljamineva faksi allalaadimine ei märgi sisendkausta kirjet vaadatuks, ei muuda töö olekut ega algata edastust.

Töödelge baite ja vigu eraldi

Õnnestumise korral tagastatakse dokumendi toorbaidid koos päistega Content-Type, Content-Disposition manuse jaoks ja Content-Length. Tegemist ei ole Base64 kodeeringuga JSON ümbrisega. Salvestage päised ja baidid näidatud viisil eraldi, kontrollige vastuse tüüpi ning alles seejärel andke failile sobiv nimi või töödelge seda. Lubatud lähtefaili laiend ei taga kehtivat ega teisendatud dokumenti.

API kood 400 tähendab, et kohustuslik teeväärtus puudub või type on vigane. API kood 404 tähendab, et kontoga seotud kirje või selle fail ei ole saadaval. Vead kasutavad tavapärast JSON status/response ümbrist ja võivad saabuda olekuga HTTP 200. Kontrollige vastuse päist Content-Type ja JSON välja status.code, et veavastuse sisu ei avataks dokumendina.

Privaatsus ja kättesaadavus

Faksi sisu võib sisaldada tundlikku teavet. Hoidke allalaaditud faile ainult seal, kus teie ettenähtud adressaadid neile ligi pääsevad, ning vältige dokumendi kõigi baitide lisamist logidesse. Postkasti kirje ei taga, et selle fail jääb kättesaadavaks. Failide säilitusaega ega iga varem salvestatud dokumendi ühilduvusgarantiid ei ole kindlaks määratud.