Parameter Name | Parameter Type | Description |
callBackEnum | string | Callback notification event type. This notification is fixed as: ENVELOPE_UPDATE |
callBackDesc | string | Callback notification event action. This notification is fixed as: ENVELOPE_DOWNLOAD_TASK_RESULT. Sent after file assembly is completed. |
timestamp | long | Callback time, in Unix timestamp format, unit: milliseconds |
CallBack EnvelopeVO | object | Callback notification payload |
| taskId | string | Download task ID. |
| status | int | Download task status: 1 - Completed. |
| envelopeId | string | Envelope ID. |
| envelopeStatus | int | Envelope Status 0- Created (Draft) 1- Signing in Progress 2- Completed 3- Expired 5-Revoked |
| downloadUrl | string | File download URL [Note] Valid for 30 minutes. After expiration, please call the API again to obtain the download URL. Returned when the original download request has downloadType=zip. |
| envelopeFiles | array | Envelope file collection [Note] Returned when the original download request has downloadType=list. |
| | fileType | string | File type CONTRACT-Signed document ATTACHMENT-Attachment CERTIFICATE-Certificate COMBINED-PDF file that merges the 'signed document' and 'certificate of completion'. Returned when 'merge envelope files for download' is enabled. |
| | fileName | string | File name |
| | downloadUrl | string | File download URL (valid for 60 minutes) |
Callback example
{
"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"
}
}