Tên tham số | Loại tham số | Mô tả |
callBackEnum | string | Loại sự kiện thông báo callback, thông báo này cố định là: ENVELOPE_UPDATE |
callBackDesc | string | Loại hành động sự kiện thông báo callback, thông báo này cố định là: ENVELOPE_DOWNLOAD_TASK_RESULT. Được gửi sau khi hoàn tất tổng hợp tệp. |
timestamp | long | Thời gian callback, định dạng dấu thời gian Unix, đơn vị: mili giây |
CallBack EnvelopeVO | object | Dữ liệu thân thông báo callback |
| taskId | string | ID tác vụ tải xuống. |
| status | int | Trạng thái tác vụ tải xuống: 1 - Đã hoàn thành. |
| envelopeId | string | ID phong bì. |
| envelopeStatus | int | Trạng thái phong bì 0- Đã tạo (bản nháp) 1- Đang ký 2- Đã hoàn thành 3- Đã hết hạn 5-Đã hủy |
| downloadUrl | string | Địa chỉ tải tệp tin [Lưu ý] Có hiệu lực trong vòng 30 phút, sau khi hết hạn vui lòng yêu cầu lại API để lấy địa chỉ tải về Trả về khi downloadType của yêu cầu tải xuống ban đầu là zip. |
| envelopeFiles | array | Tập hợp các tệp tin phong bì [Lưu ý] Trả về khi downloadType của yêu cầu tải xuống ban đầu là list. |
| | fileType | string | Loại tệp tin CONTRACT-Tệp ký ATTACHMENT-Tệp đính kèm CERTIFICATE-Chứng thư COMBINED-Tệp PDF đã gộp “Tệp ký” và “Chứng nhận hoàn tất ký”, trả về khi tính năng “Tải xuống gộp tệp phong bì” được bật |
| | fileName | string | Tên tệp tin |
| | downloadUrl | string | Địa chỉ tải tệp tin (có hiệu lực trong 60 phút) |
Ví dụ callback
{
"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"
}
}