eSign.AIeSign.AI
Entwicklerzentrum

Benachrichtigung über abgeschlossene Download-Aufgaben

Parametername

Parametertyp

Beschreibung

callBackEnum

string

Typ des Callback-Benachrichtigungsereignisses; diese Benachrichtigung ist festgelegt auf: ENVELOPE_UPDATE

callBackDesc

string

Aktion des Callback-Benachrichtigungsereignistyps; diese Benachrichtigung ist festgelegt auf: ENVELOPE_DOWNLOAD_TASK_RESULT. Wird nach Abschluss der Dateizusammenstellung gesendet.

timestamp

long

Callback-Zeit, Unix-Zeitstempel-Format, Einheit: Millisekunden

CallBack EnvelopeVO

object

Callback-Benachrichtigungsdatenkörper

 

taskId

string

Download-Aufgaben-ID.

 

status

int

Status der Download-Aufgabe: 1 – Abgeschlossen.

 

envelopeId

string

Umschlag-ID.

 

envelopeStatus

int

Umschlagstatus

0- Erstellt (Entwurf)

1- Unterzeichnet

2- Abgeschlossen

3- Abgelaufen

5- Widerrufen

 

downloadUrl

string

Datei-Download-URL

[Hinweis] Gültig für 30 Minuten. Nach Ablauf der Frist bitte die API erneut aufrufen, um die Download-URL zu erhalten.

Wird zurückgegeben, wenn im ursprünglichen Download-Anfrage downloadType=zip ist.

 

envelopeFiles

array

Sammlung von Umschlagsdateien

[Hinweis] Wird zurückgegeben, wenn im ursprünglichen Download-Anfrage downloadType=list ist.

 

 

fileType

string

Dateityp

CONTRACT- Unterschriftsdatei

ATTACHMENT- Anhang

CERTIFICATE- Zertifikat

COMBINED- PDF-Datei, die die „Unterschriftsdatei“ und den „Nachweis über abgeschlossene Unterschrift“ zusammenfasst; wird zurückgegeben, wenn die Funktion „Umschlagsdateien zusammengefasst herunterladen“ aktiviert ist

 

 

fileName

string

Dateiname

 

 

downloadUrl

string

Datei-Download-URL (gültig für 60 Minuten)

Callback-Beispiel

{
    "callBackEnum": "ENVELOPE_UPDATE",
    "callBackDesc": "ENVELOPE_DOWNLOAD_TASK_RESULT",
    "timestamp": 1789626553000,
    "callBackEnvelopeVO": {
        "taskId": "486a3f623b2c4e12993864482f371486",
        "status": 1,
        "envelopeId": "86e37b9f57564c31afe04a397170f773",
        "envelopeStatus": 1,
        "downloadUrl": "https://example.com/download/file.zip"
    }
}