Udviklere

GET/v3/fax_download?job_id={job_id}

Download et dokument fra en udgående fax

Hent det tilgængelige dokument til en af dine udgående faxopgaver.

På denne side
  1. Anmod om dokumentet
  2. Håndter en fil eller en fejl i JSON-format
  3. Tilgængelighed og privatliv

Anmod om dokumentet

Brug en aktiveret MultiTEL API-konto. Send legitimationsoplysninger med HTTP Basic for en adgangskodekonto eller et Bearer-token for en tokenkonto. Kontoens tilladelser og IP-begrænsninger gælder fortsat. Brug ikke legitimationsoplysninger til interne baggrundsprocesser.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode job_id=0123456789abcdef0123456789abcdef \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_download

Brug samme påkrævede hexadecimale job_id på 32 tegn som ved fax_status. Kundeanmodningen er begrænset til den autentificerede ejer. Dette eksempel gemmer svarheadere og byte hver for sig, så en API-fejl ikke forveksles med en PDF-fil.

Håndter en fil eller en fejl i JSON-format

Ved succes returneres dokumentets rå byte med headerne Content-Type og Content-Disposition, som angiver filtypen og at filen er vedhæftet, ikke i en JSON-indpakning. Kontrollér disse headere, før du navngiver, åbner eller behandler den gemte fil. Svaret kan være i PDF-format, TIFF-format eller det oprindelige uploadede format, afhængigt af hvilket dokument der er tilgængeligt. En opgave i kø kan returnere sin oprindelige kildefil før konvertering.

Ved fejl returneres den sædvanlige JSON-indpakning med status/response. API-kode 400 betyder, at job_id mangler eller har forkert format; 401 betyder, at autentificering mangler; 404 betyder, at opgaven eller dens fil ikke er tilgængelig for denne konto. Kontrollér Content-Type og status.code, selv når HTTP-status er 200.

Tilgængelighed og privatliv

En registreret opgave garanterer ikke, at en fil kan downloades for altid; en opbevaringsperiode er ikke blevet verificeret. Gem ved behov dokumenter, som du har tilladelse til at hente, på et lager, du selv kontrollerer. Den returnerede fil kan indeholde private oplysninger om modtageren. Download sender ikke en ny fax.