MultiTEL
Entwickler

GET/v3/fax_download?job_id={job_id}

Dokument eines ausgehenden Faxes herunterladen

Rufen Sie das verfügbare Dokument zu einem Ihrer ausgehenden Faxaufträge ab.

Auf dieser Seite
  1. Dokument anfordern
  2. Eine Datei oder einen Fehler im JSON-Format verarbeiten
  3. Verfügbarkeit und Datenschutz

Dokument anfordern

Verwenden Sie ein aktiviertes MultiTEL-Konto für die API. Senden Sie bei einem passwortbasierten Konto die Zugangsdaten für HTTP Basic oder bei einem tokenbasierten Konto ein Bearer-Token. Kontoberechtigungen und IP-Beschränkungen gelten weiterhin. Verwenden Sie keine internen Zugangsdaten der Hintergrundprozesse.

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

Verwenden Sie dieselbe erforderliche 32-stellige hexadezimale job_id wie bei fax_status. Die Kundenanfrage ist auf den authentifizierten Eigentümer beschränkt. Dieses Beispiel speichert die Antwortheader und die Antwortbytes getrennt, damit ein Fehler der API nicht mit einer PDF-Datei verwechselt wird.

Eine Datei oder einen Fehler im JSON-Format verarbeiten

Bei Erfolg werden die unverarbeiteten Bytes des Dokuments mit den Headern Content-Type und Content-Disposition für einen Dateianhang zurückgegeben, nicht in einer JSON-Antwortstruktur. Prüfen Sie diese Header, bevor Sie der gespeicherten Datei einen Namen geben, sie öffnen oder verarbeiten. Je nachdem, welches Dokument verfügbar ist, kann die Antwort im Format PDF, TIFF oder im ursprünglich hochgeladenen Format vorliegen. Bei einem Auftrag in der Warteschlange kann vor der Konvertierung die ursprüngliche Quelldatei zurückgegeben werden.

Bei einem Fehler wird die übliche JSON-Antwortstruktur mit status/response zurückgegeben. Der API-Code 400 bedeutet, dass job_id fehlt oder ein ungültiges Format hat; 401 bedeutet, dass die Authentifizierung fehlt; 404 bedeutet, dass der Auftrag oder seine Datei für dieses Konto nicht verfügbar ist. Prüfen Sie Content-Type und status.code auch dann, wenn der HTTP-Status 200 lautet.

Verfügbarkeit und Datenschutz

Ein Auftragseintrag garantiert nicht, dass eine Datei dauerhaft zum Herunterladen verfügbar ist; eine Aufbewahrungsfrist wurde nicht verifiziert. Speichern Sie Dokumente, für die Sie eine Zugriffsberechtigung haben, bei Bedarf in einem eigenen, von Ihnen kontrollierten Speicher. Die zurückgegebene Datei kann private Informationen über den Empfänger enthalten. Durch das Herunterladen wird kein neues Fax gesendet.