Ein eingehendes oder ausgehendes Dokument auswählen
Dieser Kompatibilitätsendpunkt ruft ein Faxdokument ab, das zu Ihrem Konto gehört. Verwenden Sie ein freigeschaltetes MultiTEL-Konto für die API über HTTPS mit den dafür konfigurierten Zugangsdaten und IP-Beschränkungen. Der Endpunkt versendet kein Fax und sendet auch keines erneut.
| Parameter | Erforderlich | Bedeutung |
|---|---|---|
type | Ja | Verwenden Sie inbound oder outbound genau wie angegeben. |
id | Ja | Verwenden Sie für inbound den von fax_inbox zurückgegebenen Wert hash. Verwenden Sie für outbound den von fax_outbox zurückgegebenen Wert uuid. |
Diese Werte gehören in den Pfad. Die Route lautet /v3/fax_file/{type}/{id}, nicht fax_download mit zusätzlichen Pfadsegmenten. Der Hashwert des eingehenden Faxes ist weder die numerische Datensatz-ID noch die ID eines ausgehenden Auftrags. Kopieren Sie die Kennung aus der entsprechenden Postfachliste; sie ersetzt nicht die Authentifizierung.
Ein empfangenes Fax herunterladen
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/c20ad4d76fe97759aa27a0c99bff6710Der beispielhafte Hashwert steht für den fiktiven Posteingangsdatensatz 12. Ihren eigenen Wert erhalten Sie über fax_inbox. Beim Herunterladen eines vorhandenen Posteingangsdatensatzes wird dieser als angesehen markiert. Dies geschieht, bevor die Verfügbarkeit der Datei geprüft wird. Deshalb kann viewed auch bei einem Fehler wegen einer nicht verfügbaren Datei auf true gesetzt bleiben. Verwenden Sie diesen Endpunkt nicht lediglich zur Prüfung, ob ein empfangenes Fax vorhanden ist, wenn dessen Ansichtsstatus unverändert bleiben soll.
Die Verarbeitungsroutine bevorzugt eine gespeicherte Datei im Format PDF. Andernfalls verwendet sie die gespeicherte Datei im Format TIFF und versucht, sie in PDF umzuwandeln, sofern der Konverter verfügbar ist. Ist die Konvertierung nicht verfügbar oder löst sie eine abgefangene Ausnahme aus, wird stattdessen die Datei im Format TIFF zurückgegeben. Prüfen Sie immer den zurückgegebenen Header Content-Type, anstatt vom Format PDF auszugehen.
Ein ausgehendes Fax herunterladen
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/0123456789abcdef0123456789abcdefVerwenden Sie den Wert uuid aus fax_outbox. Dieser Kompatibilitätsdownload bevorzugt einen gespeicherten Binärdatenblock im Format PDF, danach einen Binärdatenblock im Format TIFF und anschließend eine verfügbare Datei im Format PDF, eine Datei im Format TIFF oder die ursprüngliche Quelldatei. Diese Rangfolge unterscheidet sich von derjenigen der aktuellen Verarbeitungsroutine für ausgehende Faxe namens fax_download. Für neue Integrationen mit send_fax, verwenden Sie den aktuellen Downloadablauf mit dessen Parameter job_id.
Eine ursprüngliche Quelldatei kann als application/octet-stream statt als PDF oder TIFF zurückgegeben werden. Der Dateiname des Anhangs kann die ursprüngliche Dateiendung beibehalten. Der Kompatibilitätsdownload für ausgehende Faxe markiert keinen Posteingangsdatensatz als angesehen, ändert keinen Auftragsstatus und erzeugt keine Übertragung.
Bytes und Fehler getrennt verarbeiten
Bei Erfolg werden die unverarbeiteten Bytes des Dokuments mit den Headern Content-Type, Content-Disposition für einen Anhang und Content-Length zurückgegeben. Die Antwort ist keine Hülle mit Base64-kodierten Daten im Format JSON. Speichern Sie Header und Bytes wie gezeigt getrennt, prüfen Sie den Antworttyp und geben Sie der Datei erst danach einen passenden Namen oder verarbeiten Sie sie. Eine zulässige Dateiendung der Quelldatei garantiert kein gültiges oder konvertiertes Dokument.
Der API-Code 400 bedeutet, dass ein erforderlicher Pfadwert fehlt oder type ungültig ist. Der API-Code 404 bedeutet, dass der zum Konto gehörende Datensatz oder dessen Datei nicht verfügbar ist. Fehler verwenden die übliche Antwortstruktur im Format JSON mit status/response und können mit HTTP 200 zurückgegeben werden. Prüfen Sie den Header Content-Type der Antwort und das Feld status.code im Format JSON, damit ein Fehlerantworttext nicht als Dokument geöffnet wird.
Datenschutz und Verfügbarkeit
Faxinhalte können vertrauliche Informationen enthalten. Speichern Sie heruntergeladene Dateien nur an Orten, auf die ausschließlich die vorgesehenen Empfänger zugreifen können, und vermeiden Sie es, die vollständigen Dokumentbytes in Protokolle aufzunehmen. Ein Postfachdatensatz garantiert nicht, dass die zugehörige Datei weiterhin verfügbar bleibt. Es wurde weder eine Aufbewahrungsfrist für Dateien noch eine Kompatibilitätsgarantie für jedes früher gespeicherte Dokument festgelegt.