Empfangene Faxe auflisten

Verwenden Sie ein aktiviertes MultiTEL-Konto für die API über HTTPS mit den dafür konfigurierten Zugangsdaten und IP-Beschränkungen. Dieser Endpunkt listet empfangene Faxe auf, die dem authentifizierten Konto gehören. Er versendet kein Fax und lädt dessen Dokument nicht herunter.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox

Abfrageparameter für den Faxeingang
Parameter	Erforderlich	Bedeutung
`page`	Nein	Seitennummer, beginnend bei 1. Standardwert: 1.
`limit`	Nein	Datensätze pro Seite. Standardwert: 25; Höchstwert: 100. Verwenden Sie eine positive ganze Zahl.
`search`	Nein	Durchsucht die Absendernummer, die empfangende Faxnummer und die Kennung der Gegenstelle. Führende und nachgestellte Leerzeichen werden entfernt. Ob Groß- und Kleinschreibung unterschieden werden, hängt von der Sortierregel der Datenbank ab.
`date_from`	Nein	Berücksichtigt Faxe ab Beginn dieses Tages in der lokalen Zeit des Servers. Verwenden Sie YYYY-MM-DD.
`date_to`	Nein	Berücksichtigt Faxe bis einschließlich zum Ende dieses Tages in der lokalen Zeit des Servers. Verwenden Sie YYYY-MM-DD.

Die Datumsgrenzen sind eingeschlossen und richten sich nach der Datumsinterpretation des API-Servers, nicht nach einer angeforderten Benutzerzeitzone. Ungültige Datumszeichenfolgen werden möglicherweise ignoriert statt zurückgewiesen; prüfen Sie sie vor dem Senden. Ohne Datumsfilter legt die Verarbeitungsroutine keinen standardmäßigen Datumszeitraum fest. Die Ergebnisse sind nach Empfangszeit sortiert, die neuesten zuerst. Der Endpunkt bietet keinen über alle Seiten hinweg unveränderlichen Datenstand: Neu eingehende Faxe können Datensätze zwischen Seiten verschieben.

Eine Seite des Faxeingangs auslesen

Prüfen Sie das HTTP-Ergebnis und im JSON-Objekt das Feld status.code. Fehler an anderen Stellen der API können in einer JSON-Fehlerhülle zurückgegeben werden, selbst wenn der HTTP-Status 200 lautet. Eine erfolgreiche Antwort enthält response.faxes und response.pagination. Dieses Beispiel verwendet fiktive Werte.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id ist die numerische Kennung des Datensatzes im Faxeingang. hash ist dessen MD5-Darstellung für den bisherigen Ablauf zur Verarbeitung eingehender Dokumente; es handelt sich weder um eine Auftragskennung von send_fax noch um einen Berechtigungsnachweis. Verwenden Sie diesen Wert nicht mit dem für ausgehende Faxe vorgesehenen fax_status-Endpunkt.

received_timestamp ist der gespeicherte Unix-Zeitstempel. received_at ist ein vom Server formatierter Zeitstempel ohne Zeitzonenversatz oder null, wenn keine Empfangszeit erfasst wurde; verwenden Sie den Unix-Wert, wenn Sie Zeiten in Ihrer eigenen Zeitzone anzeigen. cost ist eine Zahl im JSON-Format, weder ein Preisangebot noch ein Nachweis einer gesonderten, abgeschlossenen Abbuchung.

status hat nur bei einem gespeicherten Statuscode von null den Wert success; andere Werte werden zu failed. status_text enthält die gespeicherte Verarbeitungsmeldung, ersatzweise OK oder Failed. emailed behält den gespeicherten Wert bei, statt einen booleschen Wert zu liefern. viewed ist ein boolescher Wert. Schließen Sie nicht allein aus dem Faxstatus auf eine erfolgreiche E-Mail-Zustellung.

Leere und veränderliche Listen verarbeiten

Bei einem leeren Faxeingang werden ein leeres Array faxes, total mit dem Wert 0 und total_pages mit dem Wert 0 zurückgegeben. Auch eine Seite jenseits der letzten Seite kann ein leeres Array zurückgeben. Beenden Sie das Abrufen anhand der Felder zur Seitennavigation, statt mindestens eine Seite vorauszusetzen. Es werden weder ein Cursor noch eine zusätzliche Sortierung nach Datensatzkennung bereitgestellt. Bewahren Sie Datensatzkennungen auf, wenn Sie sich überschneidende Seiten abgleichen.

Dokumentzugriff und Datenschutz

Einträge im Faxeingang enthalten private Telefon- und Dokumentmetadaten. Beschränken Sie den Zugriff in Ihrer Anwendung und vermeiden Sie es, vollständige Antworten zu protokollieren. Das Auflisten markiert ein Dokument nicht als angesehen. Verwenden Sie fax_file für den aus Kompatibilitätsgründen bereitgestellten Download eingehender Dokumente. Beachten Sie dabei, dass ein vorhandener Eingangsdatensatz auch dann als angesehen markiert wird, wenn seine Datei nicht verfügbar ist. Für den Dokumentzugriff steht auch der Faxeingang im Portal zur Verfügung. Eine Garantie für die Aufbewahrung von Dateien wurde nicht festgelegt.