Zum Inhalt

Fax-Status abfragen

Der Service Task „Fax-Status abfragen“ ruft den aktuellen Status eines Faxauftrags ab. Damit lässt sich ein bereits versendeter Auftrag (siehe Fax versenden) später erneut prüfen, etwa nach einem Timer-Event oder einer Benutzer-Aufgabe.

Wenn der Auftrag einen Endstatus erreicht hat, werden zusätzlich die Empfänger-Detailergebnisse mit ausgeliefert.

Funktion freischalten

Der Faxversand ist eine kostenpflichtige Zusatzfunktion und muss für den Mandanten freigeschaltet werden. Bei Bedarf bitte Pantarey kontaktieren.

Input-Parameter

{
  "jobId": "0d139d2c-4a10-11f1-b04d-001851328a39",
  "test": false
}

Erläuterung:

  • jobId: Eindeutige ID des Faxauftrags. Diese ID wurde beim Versand vom Service Task Fax versenden zurückgegeben.
  • test (optional, Standard false): Muss mit dem Modus übereinstimmen, in dem der Auftrag erstellt wurde. Sandbox-Aufträge sind nur über Sandbox abfragbar, Live-Aufträge nur über Live.

Output

{
  "jobId": "0d139d2c-4a10-11f1-b04d-001851328a39",
  "status": "finished",
  "errorCode": null,
  "statistics": {
    "pages": 1,
    "recipientCount": 1,
    "recipientCountSuccessful": 1,
    "recipientCountError": 0
  },
  "recipients": [
    {
      "faxNumber": "0049530000000",
      "resultCode": 0,
      "resultText": "OK"
    }
  ]
}

Erläuterung:

  • jobId: Auftrags-ID (gleicher Wert wie im Input).
  • status: Aktueller Status. Mögliche Werte:
    • scheduling, scheduled, processing – Auftrag ist noch in Bearbeitung.
    • halted, locked – Auftrag pausiert; nicht endgültig.
    • finished, error, canceled – Endstatus; das Ergebnis ändert sich nicht mehr.
  • errorCode: null bei Erfolg, andernfalls ein Fehlercode des Versanddienstes.
  • statistics: Anzahl Seiten und Empfänger (gesamt, erfolgreich, fehlgeschlagen).
  • recipients: Wird nur bei einem Endstatus gefüllt. Enthält pro Empfänger das Einzelergebnis (resultCode 0 = erfolgreich zugestellt).

JSONata-Beispiel

{
  "jobId": $.faxJob.jobId,
  "test": $.faxJob.test
}

Hinweise

  • Zwischenstände: Solange der Auftrag noch nicht abgeschlossen ist, enthält der Output keine Empfängerdetails. In diesem Fall sollte der Task – z. B. nach einem Timer – erneut aufgerufen werden.
  • Status finished ≠ erfolgreicher Einzelversand: Auch wenn der Auftrag insgesamt abgeschlossen ist, kann ein einzelner Empfänger fehlgeschlagen sein. Maßgeblich ist recipients[*].resultCode.
  • Sandbox vs. Live: Es kann nur abgefragt werden, was im selben Modus erstellt wurde. Wird ein Testauftrag versehentlich im Echtmodus abgefragt (oder umgekehrt), wird „Auftrag nicht gefunden“ zurückgegeben.

Tipp

Diesen Service Task in Kombination mit einem Timer-Event einsetzen, wenn der Versand asynchron geprüft werden soll – z. B. wenn der Versand eines Faxes eine bestimmte Zeit dauern darf, bevor eine Eskalation ausgelöst wird. Der Versand-Task Fax versenden selbst wartet bereits standardmäßig bis zu rund 70 Sekunden.