Een fax uit de inbox of outbox downloaden

Kies een inkomend of uitgaand document

Dit compatibiliteitseindpunt haalt een faxdocument op dat bij uw account hoort. Gebruik een ingeschakeld MultiTEL API-account via HTTPS met de daarvoor ingestelde aanmeldgegevens en IP-beperkingen. Het eindpunt verzendt geen fax en verzendt ook geen fax opnieuw.

Padparameters voor het downloaden
Parameter	Verplicht	Betekenis
`type`	Ja	Gebruik inbound of outbound, precies zoals weergegeven.
`id`	Ja	Gebruik voor inbound de hash die door fax_inbox wordt geretourneerd. Gebruik voor outbound de uuid die door fax_outbox wordt geretourneerd.

Deze waarden horen in het pad. De route is /v3/fax_file/{type}/{id}, niet fax_download met extra padsegmenten. De hash van de inkomende fax is niet de numerieke record-ID en ook niet de ID van een uitgaande taak. Kopieer de identificatie uit de juiste inbox- of outboxlijst; deze vervangt de authenticatie niet.

Een ontvangen fax downloaden

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

De hash in het voorbeeld staat voor fictief inboxrecord 12. Haal uw eigen waarde op via fax_inbox. Bij het downloaden wordt een bestaand inkomend record als bekeken gemarkeerd. Dit gebeurt voordat de beschikbaarheid van het bestand wordt gecontroleerd, waardoor viewed ook bij een fout wegens een niet-beschikbaar bestand op true kan blijven staan. Gebruik dit eindpunt niet uitsluitend om te controleren of een ontvangen fax bestaat als u wilt dat de bekekenstatus ongewijzigd blijft.

De verwerkingsroutine geeft de voorkeur aan een opgeslagen PDF. Anders gebruikt deze de opgeslagen TIFF en probeert deze het bestand naar PDF te converteren wanneer het conversieprogramma beschikbaar is. Als conversie niet beschikbaar is of een afgevangen uitzondering veroorzaakt, wordt in plaats daarvan de TIFF geretourneerd. Controleer altijd de geretourneerde Content-Type in plaats van uit te gaan van PDF.

Een uitgaande fax downloaden

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

Gebruik de uuid uit fax_outbox. Deze compatibiliteitsdownload geeft eerst de voorkeur aan een opgeslagen binair object in PDF-formaat, vervolgens aan een binair object in TIFF-formaat en daarna aan een beschikbaar PDF-bestand, TIFF-bestand of oorspronkelijk bronbestand. Deze voorkeursvolgorde verschilt van die van de huidige verwerkingsroutine voor uitgaande faxen fax_download. Gebruik voor nieuwe integraties die gebruikmaken van send_fax, die huidige downloadworkflow met de bijbehorende parameter job_id.

Een oorspronkelijk bronbestand kan worden geretourneerd als application/octet-stream in plaats van PDF of TIFF. De bestandsnaam van de bijlage kan de oorspronkelijke extensie behouden. De compatibiliteitsdownload voor uitgaande faxen markeert geen inboxrecord als bekeken, wijzigt de taakstatus niet en maakt geen verzending aan.

Verwerk bytes en fouten afzonderlijk

Bij succes worden de onbewerkte bytes van het document geretourneerd met de headers Content-Type, Content-Disposition met de aanduiding voor een bijlage en Content-Length. Het is geen omhullende structuur met Base64-gegevens in JSON. Sla de headers en bytes afzonderlijk op zoals weergegeven, controleer het responstype en geef het bestand pas daarna een passende naam of verwerk het. Een toegestane extensie van het bronbestand garandeert niet dat het document geldig of geconverteerd is.

API-code 400 betekent dat een verplichte padwaarde ontbreekt of dat type ongeldig is. API-code 404 betekent dat het record binnen het account of het bijbehorende bestand niet beschikbaar is. Fouten gebruiken de gebruikelijke JSON-structuur met status/response en kunnen met HTTP 200 worden geretourneerd. Controleer de Content-Type van de respons en JSON-veld status.code, zodat de inhoud van een foutrespons niet als document wordt geopend.

Privacy en beschikbaarheid

Faxen kunnen gevoelige informatie bevatten. Bewaar gedownloade bestanden uitsluitend op locaties waar alleen de beoogde ontvangers toegang toe hebben en neem niet de volledige bytes van documenten op in logbestanden. Een inbox- of outboxrecord garandeert niet dat het bijbehorende bestand beschikbaar blijft. Er is geen bewaartermijn voor bestanden vastgesteld en er is geen compatibiliteitsgarantie voor elk in het verleden opgeslagen document.