Shkarkoni një faks nga kutia hyrëse ose dalëse

Zgjidhni një dokument hyrës ose dalës

Kjo pikë fundore për pajtueshmëri merr një dokument faksi që i përket llogarisë suaj. Përdorni një llogari të aktivizuar MultiTEL API përmes HTTPS, me kredencialet dhe kufizimet IP të konfiguruara për të. Ajo nuk dërgon dhe nuk ridërgon fakse.

Këto vlera vendosen në shteg. Rruga është /v3/fax_file/{type}/{id}, jo fax_download me segmente shtesë në shteg. Hash-i i faksit hyrës nuk është identifikuesi numerik i regjistrimit dhe as identifikuesi i një detyre dalëse. Kopjojeni identifikuesin nga lista e kutisë përkatëse; ai nuk e zëvendëson autentikimin.

Shkarkoni një faks të marrë

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

Hash-i në shembull përfaqëson regjistrimin imagjinar 12 të kutisë hyrëse. Merrni vlerën tuaj nga fax_inbox. Shkarkimi i një regjistrimi hyrës ekzistues e shënon atë si të parë. Kjo ndodh përpara se të kontrollohet disponueshmëria e skedarit, prandaj edhe një gabim që tregon se skedari nuk është i disponueshëm mund ta lërë viewed me vlerën true. Mos e përdorni këtë pikë fundore vetëm për të kontrolluar nëse ekziston një faks i marrë, nëse dëshironi që gjendja e tij e shikimit të mbetet e pandryshuar.

Trajtuesi i jep përparësi një skedari PDF të ruajtur. Përndryshe, përdor skedarin TIFF të ruajtur dhe përpiqet ta konvertojë në PDF kur konvertuesi është i disponueshëm. Nëse konvertimi nuk është i disponueshëm ose shkakton një përjashtim që trajtohet, kthen në vend të tij skedarin TIFF. Kontrolloni gjithmonë Content-Type të kthyer, në vend që të supozoni se formati është PDF.

Shkarkoni një faks dalës

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

Përdorni vlerën uuid nga fax_outbox. Ky shkarkim për pajtueshmëri i jep përparësi një objekti binar PDF të ruajtur, pastaj një objekti binar TIFF, pastaj një skedari PDF, një skedari TIFF ose skedarit burimor origjinal, nëse është i disponueshëm. Rendi i përparësisë së tij ndryshon nga ai i trajtuesit aktual për fakset dalëse fax_download. Për integrimet e reja që përdorin send_fax, përdorni atë rrjedhë aktuale të shkarkimit me parametrin e saj job_id.

Një skedar burimor origjinal mund të kthehet si application/octet-stream në vend të PDF ose TIFF. Emri i skedarit të bashkëngjitur mund të ruajë prapashtesën e burimit. Shkarkimi për pajtueshmëri i fakseve dalëse nuk shënon si të parë ndonjë regjistrim në kutinë hyrëse, nuk ndryshon statusin e detyrës dhe nuk krijon një transmetim.

Trajtoni veçmas bajtet dhe gabimet

Në rast suksesi, kthehen bajtet e papërpunuara të dokumentit me fushat e kreut Content-Type, Content-Disposition për bashkëngjitje dhe Content-Length. Përgjigjja nuk është një strukturë mbështjellëse JSON me të dhëna në Base64. Ruani veçmas fushat e kreut dhe bajtet siç tregohet, kontrolloni llojin e përgjigjes dhe vetëm pastaj jepini skedarit një emër të përshtatshëm ose përpunojeni. Një prapashtesë burimore e lejuar nuk garanton një dokument të vlefshëm ose të konvertuar.

Kodi API 400 do të thotë se mungon një vlerë e detyrueshme në shteg ose se type është i pavlefshëm. Kodi API 404 do të thotë se regjistrimi që i përket llogarisë ose skedari i tij nuk është i disponueshëm. Gabimet përdorin strukturën e zakonshme mbështjellëse JSON me status/response dhe mund të përdorin HTTP 200. Kontrolloni Content-Type të përgjigjes dhe vlerën status.code në JSON, që trupi i një përgjigjeje gabimi të mos hapet si dokument.

Privatësia dhe disponueshmëria

Përmbajtja e faksit mund të përfshijë informacion të ndjeshëm. Ruajini skedarët e shkarkuar vetëm në vende ku marrësit e synuar mund të kenë qasje dhe shmangni përfshirjen e të gjithë bajteve të dokumentit në regjistrat e sistemit. Një regjistrim në kutinë e fakseve nuk garanton që skedari i tij do të mbetet i disponueshëm. Nuk është përcaktuar asnjë periudhë ruajtjeje e skedarëve dhe asnjë garanci pajtueshmërie për çdo dokument të ruajtur në të kaluarën.