Tải xuống tệp

GET /esignglobal/v1/envelope/files/download

Mô tả giao diện

Khi phong bì đang được ký hoặc đã hoàn thành, hỗ trợ tải xuống các tệp bên trong phong bì. Việc tải xuống trong quá trình ký bị ràng buộc bởi cấu hình tải xuống theo quy trình, quyền tải xuống và quy tắc hiển thị tệp; nếu cần tổng hợp watermark bất đồng bộ cho tệp trong quá trình ký, giao diện sẽ trả về ID tác vụ tải xuống, khách hàng có thể lấy kết quả tệp thông qua giao diện truy vấn tác vụ tải xuống hoặc callback hoàn thành tác vụ tải xuống.

Tham số yêu cầu

Tên tham số	Kiểu	Bắt buộc	Giải thích
envelopeId	string	true	ID phong bì
downloadType	string	false	Loại định dạng tải xuống tệp: zip (mặc định): trả về liên kết tải xuống gói nén list: trả về danh sách tệp

Ví dụ yêu cầu

GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list

Tham số phản hồi

Tên tham số		Kiểu	Mô tả
envelopeId		string	ID phong bì
envelopeStatus		int	Trạng thái phong bì 0- Đã tạo (bản nháp) 1- Đang ký 2-0.00007896543210987654 3- Đã hết hạn 5- Đã hủy
taskId		string	ID tác vụ tải xuống. Chỉ trả về khi phong bì đang trong trạng thái ký và tệp cần tổng hợp watermark bất đồng bộ. [Lưu ý] Khi trả về taskId, sẽ không trả về các trường kết quả tệp như downloadUrl, envelopeFiles.
downloadUrl		string	Địa chỉ tải xuống tệp [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 xuống Được trả về khi downloadType=zip và có thể trả về kết quả tệp đồng bộ; không trả về trường này khi trả về taskId.
envelopeFiles		array	Tập hợp các tệp của phong bì [Lưu ý] Được trả về khi downloadType=list và có thể trả về kết quả tệp đồng bộ; không trả về trường này khi trả về taskId.
	fileType	string	Loại tệp CONTRACT- Tệp ký ATTACHMENT- Tệp đính kèm CERTIFICATE- Chứng chỉ COMBINED- Tệp PDF đã hợp nhất "Tệp ký" và "Chứng nhận hoàn tất ký", được trả về khi tùy chọn "Tải xuống các tệp trong phong bì đã hợp nhất" được bật
	fileName	string	Tên tệp
	downloadUrl	string	URL tải xuống tệp (có hiệu lực trong vòng 60 phút)

Ví dụ phản hồi

{
    "code": "0",
    "data": {
    "envelopeId": "xxxx",
      "downloadUrl": "下载地址",
      "envelopeStatus": 2
  },
  "message": "success"
}

Khi trạng thái là đang ký và tệp cần tổng hợp watermark bất đồng bộ, ví dụ phản hồi như sau:

{
    "code": "0",
    "data": {
      "envelopeId": "xxxx",
      "envelopeStatus": 1,
      "taskId": "task1234567890"
  },
  "message": "success"
}