Download en fax fra indbakken eller udbakken

Vælg et indgående eller udgående dokument

Dette kompatibilitetsendepunkt henter et faxdokument, der tilhører din konto. Brug en aktiveret MultiTEL-konto til API via HTTPS med de konfigurerede legitimationsoplysninger og IP-begrænsninger. Det sender eller gensender ikke en fax.

Disse værdier skal angives i stien. Ruten er /v3/fax_file/{type}/{id}, ikke fax_download med ekstra stisegmenter. Hashværdien for den indgående fax er hverken postens numeriske ID eller et ID for et udgående job. Kopiér identifikatoren fra oversigten over den relevante indbakke eller udbakke; den erstatter ikke autentificering.

Download en modtaget fax

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

Hashværdien i eksemplet repræsenterer den fiktive indbakkepost 12. Hent din egen værdi fra fax_inbox. Når en eksisterende indbakkepost downloades, markeres den som vist. Det sker, før det kontrolleres, om filen er tilgængelig, så selv ved en fejl om, at filen ikke er tilgængelig, kan viewed være sat til true. Brug ikke dette endepunkt alene til at undersøge, om en modtaget fax findes, hvis du vil bevare dens visningsstatus uændret.

Behandlingsfunktionen foretrækker en gemt PDF. Ellers bruger den den gemte TIFF og forsøger at konvertere til PDF, når konverteringsværktøjet er tilgængeligt. Hvis konvertering ikke er tilgængelig eller udløser en undtagelse, som håndteres, returnerer den i stedet TIFF. Kontrollér altid den returnerede Content-Type i stedet for at antage, at formatet er PDF.

Download en udgående fax

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

Brug værdien for uuid fra fax_outbox. Denne kompatibilitetsdownload foretrækker en gemt binær PDF-datablok, derefter en binær TIFF-datablok og derefter en tilgængelig PDF-fil, TIFF-fil eller oprindelig kildefil. Dens prioriteringsrækkefølge adskiller sig fra rækkefølgen i den nuværende funktion til udgående faxer, fax_download. Til nye integrationer, der bruger send_fax, skal du bruge denne nuværende downloadarbejdsgang med dens parameter job_id.

En oprindelig kildefil kan blive returneret som application/octet-stream i stedet for PDF eller TIFF. Den vedhæftede fils navn kan bevare kildefilens filendelse. Kompatibilitetsdownload af udgående faxer markerer ikke en indbakkepost som vist, ændrer ikke jobbets status og opretter ikke en transmission.

Håndter bytes og fejl hver for sig

Ved succes returneres dokumentets rå bytes med headerne Content-Type, Content-Disposition med angivelse af vedhæftet fil og Content-Length. Svaret er ikke en JSON-indpakning med Base64. Gem headere og bytes hver for sig som vist, kontrollér svartypen, og giv først derefter filen et passende navn eller behandl den. En tilladt filendelse for kildefilen garanterer ikke, at dokumentet er gyldigt eller konverteret.

Koden 400 fra API betyder, at en påkrævet værdi i stien mangler, eller at type er ugyldig. Koden 404 fra API betyder, at posten på kontoen eller dens fil ikke er tilgængelig. Fejl bruger den normale JSON-indpakning med status/response og kan bruge HTTP 200. Kontrollér svarets Content-Type og status.code i JSON, så en fejlmeddelelse i svarindholdet ikke åbnes som et dokument.

Privatliv og tilgængelighed

Faxindhold kan indeholde følsomme oplysninger. Gem kun downloadede filer steder, hvor dine tilsigtede modtagere kan få adgang til dem, og undgå at medtage dokumentets fulde byteindhold i logfiler. En post i indbakken eller udbakken garanterer ikke, at dens fil forbliver tilgængelig. Der er ikke fastlagt nogen opbevaringsperiode for filer eller nogen kompatibilitetsgaranti, der dækker alle historiske gemte dokumenter.