Preuzimanje faksa iz ulaznog ili izlaznog pretinca

Odaberite ulazni ili izlazni dokument

Ova krajnja točka za kompatibilnost dohvaća dokument faksa koji pripada vašem računu. Upotrijebite omogućen MultiTEL račun za API putem protokola HTTPS, s konfiguriranim vjerodajnicama i ograničenjima IP adresa. Ne šalje niti ponovno šalje faks.

Te se vrijednosti navode u putanji. Ruta je /v3/fax_file/{type}/{id}, a ne fax_download s dodatnim segmentima putanje. Hash vrijednost ulaznog faksa nije brojčani ID zapisa niti ID izlaznog zadatka. Kopirajte identifikator iz popisa odgovarajućeg pretinca; on ne zamjenjuje autentifikaciju.

Preuzmite primljeni 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

Hash vrijednost u primjeru predstavlja izmišljeni zapis 12 u ulaznom pretincu. Vlastitu vrijednost dohvatite iz fax_inbox. Preuzimanjem postojećeg ulaznog zapisa taj se zapis označava kao pregledan. To se događa prije provjere dostupnosti datoteke, pa čak i ako se vrati pogreška da datoteka nije dostupna, viewed može ostati postavljen na true. Nemojte upotrebljavati ovu krajnju točku samo za provjeru postoji li primljeni faks ako želite da njegov status pregledanosti ostane nepromijenjen.

Funkcija za obradu daje prednost pohranjenom dokumentu u formatu PDF. U suprotnom upotrebljava pohranjeni dokument u formatu TIFF i pokušava ga pretvoriti u PDF ako je pretvornik dostupan. Ako pretvorba nije dostupna ili izazove iznimku koju sustav obrađuje, umjesto toga vraća TIFF. Uvijek provjerite vraćeno zaglavlje Content-Type umjesto da pretpostavite da je format PDF.

Preuzmite izlazni 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

Upotrijebite vrijednost uuid iz fax_outbox. Ovo preuzimanje radi kompatibilnosti daje prednost pohranjenom binarnom objektu u formatu PDF, zatim binarnom objektu u formatu TIFF, a zatim dostupnoj datoteci u formatu PDF, datoteci u formatu TIFF ili izvornoj datoteci. Njegov redoslijed prioriteta razlikuje se od redoslijeda koji za izlazne faksove primjenjuje trenutačna funkcija fax_download. Za nove integracije koje upotrebljavaju send_fax, upotrijebite taj trenutačni tijek preuzimanja s njegovim parametrom job_id.

Izvorna datoteka može biti vraćena kao application/octet-stream umjesto u formatu PDF ili TIFF. Naziv priložene datoteke može zadržati izvorni nastavak. Preuzimanje izlaznih faksova radi kompatibilnosti ne označava zapis u ulaznom pretincu kao pregledan, ne mijenja status zadatka niti pokreće prijenos.

Obrađujte bajtove i pogreške zasebno

Uspješan odgovor vraća sirove bajtove dokumenta sa zaglavljima Content-Type, Content-Disposition s oznakom privitka i Content-Length. To nije omotnica u formatu JSON s podacima kodiranim kao Base64. Spremite zaglavlja i bajtove zasebno kako je prikazano, provjerite vrstu odgovora i tek tada dodijelite datoteci odgovarajući naziv ili je obradite. Dopušteni nastavak izvorne datoteke ne jamči valjan ili pretvoren dokument.

Kod 400 koji vraća API znači da nedostaje obavezna vrijednost u putanji ili da type nije valjan. Kod 404 koji vraća API znači da zapis unutar računa ili njegova datoteka nisu dostupni. Pogreške upotrebljavaju uobičajenu omotnicu JSON s poljima status/response i mogu biti vraćene uz HTTP 200. Provjerite zaglavlje odgovora Content-Type i polje status.code u formatu JSON kako se tijelo odgovora s pogreškom ne bi otvorilo kao dokument.

Privatnost i dostupnost

Sadržaj faksa može sadržavati osjetljive podatke. Preuzete datoteke pohranjujte samo ondje gdje im mogu pristupiti predviđeni primatelji i izbjegavajte zapisivanje svih bajtova dokumenta u zapisnike. Zapis u pretincu ne jamči da će njegova datoteka ostati dostupna. Nije utvrđeno razdoblje čuvanja datoteka niti jamstvo kompatibilnosti za svaki dokument pohranjen u prošlosti.