Last ned en faks fra innboksen eller utboksen

Velg et innkommende eller utgående dokument

Dette endepunktet for bakoverkompatibilitet henter et faksdokument som tilhører kontoen din. Bruk en aktivert MultiTEL API-konto over HTTPS med kontoens konfigurerte påloggingsopplysninger og IP-begrensninger. Det sender ikke en faks og sender heller ikke en faks på nytt.

Disse verdiene skal stå i stien. Ruten er /v3/fax_file/{type}/{id}, ikke fax_download med ekstra stisegmenter. Hashverdien for den innkommende faksen er ikke postens numeriske ID og er heller ikke en ID for en utgående jobb. Kopier identifikatoren fra listen for den aktuelle postboksen; den erstatter ikke autentisering.

Last ned en mottatt 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

Hashverdien i eksemplet representerer den fiktive innboksposten 12. Hent din egen verdi fra fax_inbox. Når du laster ned en eksisterende innkommende post, merkes den som vist. Dette skjer før det kontrolleres om filen er tilgjengelig, så selv en feil om at filen ikke er tilgjengelig, kan føre til at viewed forblir satt til true. Ikke bruk dette endepunktet bare for å undersøke om en mottatt faks finnes, hvis du vil at visningsstatusen skal forbli uendret.

Behandlingsfunksjonen foretrekker en lagret PDF. Ellers bruker den den lagrede TIFF-filen og forsøker å konvertere til PDF når konverteringsverktøyet er tilgjengelig. Hvis konvertering ikke er tilgjengelig eller utløser et unntak som håndteres, returnerer den TIFF-filen i stedet. Kontroller alltid den returnerte Content-Type-headeren fremfor å anta at formatet er PDF.

Last ned en utgående 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

Bruk uuid fra fax_outbox. Denne nedlastingen for bakoverkompatibilitet foretrekker først et lagret binærobjekt i PDF-format, deretter et binærobjekt i TIFF-format og så en tilgjengelig PDF-fil, TIFF-fil eller opprinnelig kildefil. Prioriteringsrekkefølgen er forskjellig fra den som brukes for utgående faks i den gjeldende fax_download-behandlingsfunksjonen. For nye integrasjoner som bruker send_fax, bruker du den gjeldende arbeidsflyten for nedlasting med parameteren job_id.

En opprinnelig kildefil kan returneres som application/octet-stream i stedet for PDF eller TIFF. Filnavnet til vedlegget kan beholde kildefilens filtype. Nedlasting av utgående faks for bakoverkompatibilitet merker ikke en innbokspost som vist, endrer ikke jobbstatusen og oppretter ingen overføring.

Håndter byte og feil hver for seg

Ved suksess returneres dokumentets rå byte med headerne Content-Type, Content-Disposition som angir vedlegg, og Content-Length. Dette er ikke en svarinnpakning med Base64-data i JSON-format. Lagre headere og byte hver for seg som vist, kontroller svartypen, og gi først deretter filen et passende navn eller behandle den. En tillatt filtype for kildefilen garanterer ikke at dokumentet er gyldig eller konvertert.

API-kode 400 betyr at en påkrevd stiverdi mangler, eller at type er ugyldig. API-kode 404 betyr at posten som tilhører kontoen, eller filen til posten, ikke er tilgjengelig. Feil bruker den vanlige JSON-svarinnpakningen med status/response og kan bruke HTTP 200. Kontroller svarets Content-Type og JSON-feltet status.code, slik at en feilmelding i svarkroppen ikke åpnes som et dokument.

Personvern og tilgjengelighet

Faksinnhold kan inneholde sensitive opplysninger. Lagre nedlastede filer bare på steder der de tiltenkte mottakerne har tilgang, og unngå å ta med alle dokumentets byte i logger. En post i postboksen garanterer ikke at filen vil forbli tilgjengelig. Det er ikke fastsatt noen oppbevaringstid for filer eller gitt noen kompatibilitetsgaranti som dekker alle tidligere lagrede dokumenter.