Ontwikkelaars

GET/v3/fax_download?job_id={job_id}

Een document van een uitgaande fax downloaden

Haal het beschikbare document op voor een van uw uitgaande faxopdrachten.

Op deze pagina
  1. Het document opvragen
  2. Een bestand of een fout in JSON-formaat verwerken
  3. Beschikbaarheid en privacy

Het document opvragen

Gebruik een ingeschakeld MultiTEL API-account. Stuur voor een account met een wachtwoord de aanmeldgegevens via HTTP Basic, of voor een account met een token een Bearer-token. Accountrechten en IP-beperkingen blijven van toepassing. Gebruik geen interne aanmeldgegevens van de achtergrondverwerker.

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

Gebruik dezelfde verplichte hexadecimale job_id van 32 tekens als bij fax_status. Het klantverzoek is uitsluitend toegestaan voor de geauthenticeerde eigenaar. In dit voorbeeld worden de antwoordheaders en de bytes afzonderlijk opgeslagen, zodat een API-fout niet wordt aangezien voor een PDF-bestand.

Een bestand of een fout in JSON-formaat verwerken

Bij succes worden de ruwe documentbytes teruggegeven met de headers Content-Type en Content-Disposition voor een bijlage, en niet in een JSON-envelop. Controleer deze headers voordat u het opgeslagen bestand een naam geeft, opent of verwerkt. Afhankelijk van welk document beschikbaar is, kan het antwoord een bestand in PDF-formaat, TIFF-formaat of het oorspronkelijke uploadformaat bevatten. Bij een opdracht in de wachtrij kan vóór de conversie het oorspronkelijke bronbestand worden teruggegeven.

Bij een fout wordt de gebruikelijke JSON-envelop met status/response teruggegeven. API-code 400 betekent dat job_id ontbreekt of een onjuiste indeling heeft; 401 betekent dat authenticatie ontbreekt; 404 betekent dat de opdracht of het bijbehorende bestand niet beschikbaar is voor dit account. Controleer Content-Type en status.code, ook als de HTTP-status 200 is.

Beschikbaarheid en privacy

Een geregistreerde opdracht garandeert niet dat het bestand voor altijd kan worden gedownload; er is geen bewaartermijn geverifieerd. Sla documenten waartoe u toegang mag hebben zo nodig op in uw eigen opslag die u zelf beheert. Het teruggegeven bestand kan vertrouwelijke informatie over de ontvanger bevatten. Door te downloaden wordt geen nieuwe fax verzonden.