Ladda ned ett fax från inkorgen eller utkorgen

Välj ett inkommande eller utgående dokument

Den här kompatibilitetsändpunkten hämtar ett faxdokument som tillhör ditt konto. Använd ett aktiverat MultiTEL API-konto via HTTPS med kontots konfigurerade autentiseringsuppgifter och IP-begränsningar. Den skickar inte fax och skickar inte heller om fax.

Dessa värden ska anges i sökvägen. Anropssökvägen är /v3/fax_file/{type}/{id}, inte fax_download med extra sökvägssegment. Hashvärdet för ett inkommande fax är varken postens numeriska ID eller ett ID för ett utgående jobb. Kopiera identifieraren från listan i rätt brevlåda; den ersätter inte autentisering.

Ladda ned ett mottaget 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ärdet i exemplet motsvarar den fiktiva inkorgsposten 12. Hämta ditt eget värde från fax_inbox. När du laddar ned en befintlig inkommande post markeras den som visad. Detta sker innan filens tillgänglighet kontrolleras, så även ett fel som anger att filen inte är tillgänglig kan lämna viewed satt till true. Använd inte den här ändpunkten enbart för att kontrollera om ett mottaget fax finns om du vill att dess visningsstatus ska förbli oförändrad.

Hanteraren väljer i första hand en lagrad PDF-fil. Annars använder den den lagrade TIFF-filen och försöker konvertera den till PDF om konverteraren är tillgänglig. Om konvertering inte är tillgänglig eller utlöser ett undantag som hanteras, returneras TIFF-filen i stället. Kontrollera alltid det returnerade Content-Type-huvudet i stället för att förutsätta att formatet är PDF.

Ladda ned ett utgå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

Använd uuid-värdet från fax_outbox. Den här kompatibilitetsnedladdningen väljer i första hand en lagrad PDF-blob, därefter en TIFF-blob och sedan en tillgänglig PDF-fil, TIFF-fil eller ursprunglig källfil. Prioritetsordningen skiljer sig från den som används av den nuvarande utgående fax_download-hanteraren. För nya integrationer som använder send_fax, använd det nuvarande nedladdningsflödet med dess job_id-parameter.

En ursprunglig källfil kan returneras som application/octet-stream i stället för PDF eller TIFF. Bilagans filnamn kan behålla källfilens filändelse. Kompatibilitetsnedladdningen för utgående fax markerar inte någon inkorgspost som visad, ändrar inte jobbets status och skapar inte någon överföring.

Hantera byte och fel separat

Vid ett lyckat anrop returneras dokumentets råa byte med huvudena Content-Type, Content-Disposition med värdet attachment och Content-Length. Svaret är inte ett JSON-omslag med Base64-kodade data. Spara huvuden och byte separat enligt exemplet, kontrollera svarstypen och ge först därefter filen ett lämpligt namn eller bearbeta den. En tillåten filändelse för källfilen garanterar inte att dokumentet är giltigt eller konverterat.

API-kod 400 betyder att ett obligatoriskt sökvägsvärde saknas eller att type är ogiltigt. API-kod 404 betyder att posten som hör till kontot eller dess fil inte är tillgänglig. Fel använder det vanliga JSON-omslaget med status/response och kan använda HTTP 200. Kontrollera svarets Content-Type och status.code i JSON, så att en felmeddelandekropp inte öppnas som ett dokument.

Integritet och tillgänglighet

Fax kan innehålla känsliga uppgifter. Lagra nedladdade filer endast där de avsedda mottagarna kan komma åt dem, och undvik att ta med dokumentets samtliga byte i loggar. En post i en brevlåda garanterar inte att dess fil förblir tillgänglig. Ingen lagringstid för filer eller kompatibilitetsgaranti som omfattar alla äldre lagrade dokument har fastställts.