Atsisiųsti gautą arba siunčiamą faksą

Pasirinkite gautą arba siunčiamą dokumentą

Šis suderinamumui skirtas galinis taškas leidžia gauti jūsų paskyrai priklausantį fakso dokumentą. Naudokite įjungtą MultiTEL API paskyrą per HTTPS su jai sukonfigūruotais prisijungimo duomenimis ir IP apribojimais. Jis nesiunčia fakso ir nesiunčia jo pakartotinai.

Šios reikšmės turi būti nurodytos kelyje. Maršrutas yra /v3/fax_file/{type}/{id}, o ne fax_download su papildomais kelio segmentais. Gauto fakso maišos reikšmė nėra skaitinis įrašo identifikatorius ir nėra siuntimo užduoties identifikatorius. Nukopijuokite identifikatorių iš atitinkamo gautųjų arba siunčiamųjų sąrašo; jis neatstoja autentifikavimo.

Atsisiųsti gautą 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

Pavyzdyje pateikta maišos reikšmė atitinka išgalvotą gautųjų įrašą 12. Savo reikšmę gaukite iš fax_inbox. Atsisiunčiant esamą gauto fakso įrašą, jis pažymimas kaip peržiūrėtas. Tai įvyksta prieš patikrinant failo prieinamumą, todėl net ir įvykus klaidai dėl neprieinamo failo lauko viewed reikšmė gali likti true. Nenaudokite šio galinio taško vien tam, kad patikrintumėte, ar gautas faksas egzistuoja, jei norite, kad jo peržiūros būsena nepasikeistų.

Apdorojimo programa pirmiausia renkasi išsaugotą PDF. Kitu atveju ji naudoja išsaugotą TIFF ir, jei konvertavimo priemonė prieinama, bando konvertuoti į PDF. Jei konvertavimas neprieinamas arba sukelia apdorojamą išimtį, vietoj to grąžinamas TIFF. Visada patikrinkite grąžintą Content-Type, užuot manę, kad tai PDF.

Atsisiųsti siunčiamą 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

Naudokite uuid iš fax_outbox. Šis suderinamumui skirtas atsisiuntimas pirmiausia renkasi išsaugotą PDF dvejetainių duomenų objektą, tada TIFF dvejetainių duomenų objektą, o po to prieinamą PDF failą, TIFF failą arba pradinį šaltinio failą. Ši pasirinkimo tvarka skiriasi nuo dabartinės siunčiamų faksų apdorojimo programos fax_download pasirinkimo tvarkos. Naujose integracijose, kuriose naudojama send_fax, naudokite tą dabartinę atsisiuntimo eigą su jos parametru job_id.

Pradinis šaltinio failas gali būti grąžintas kaip application/octet-stream, o ne PDF ar TIFF. Priedo failo pavadinimas gali išlaikyti šaltinio plėtinį. Suderinamumui skirtas siunčiamo fakso atsisiuntimas nepažymi gautųjų įrašo kaip peržiūrėto, nekeičia užduoties būsenos ir nesukuria siuntimo.

Baitus ir klaidas apdorokite atskirai

Sėkmės atveju grąžinami neapdoroti dokumento baitai su antraštėmis Content-Type, Content-Disposition, nurodančia priedą, ir Content-Length. Tai nėra Base64 koduotės duomenis apgaubiantis JSON objektas. Išsaugokite antraštes ir baitus atskirai, kaip parodyta, patikrinkite atsakymo tipą ir tik tada suteikite failui tinkamą pavadinimą arba jį apdorokite. Leidžiamas šaltinio plėtinys negarantuoja, kad dokumentas tinkamas arba konvertuotas.

API kodas 400 reiškia, kad trūksta privalomos kelio reikšmės arba type yra netinkamas. API kodas 404 reiškia, kad paskyrai priklausantis įrašas arba jo failas neprieinamas. Klaidoms naudojamas įprastas JSON status/response atsakymo apvalkalas ir gali būti naudojamas HTTP 200. Patikrinkite atsakymo Content-Type ir JSON lauką status.code, kad klaidos turinys nebūtų atidarytas kaip dokumentas.

Privatumas ir prieinamumas

Fakso turinyje gali būti neskelbtinos informacijos. Atsisiųstus failus saugokite tik ten, kur juos gali pasiekti numatyti gavėjai, ir venkite į žurnalus įtraukti visus dokumento baitus. Įrašas gautųjų ar siunčiamųjų sąraše negarantuoja, kad jo failas liks prieinamas. Failų saugojimo laikotarpis nenustatytas ir suderinamumas su kiekvienu anksčiau išsaugotu dokumentu negarantuojamas.