eSignGlobaleSignGlobal
Trung tâm nhà phát triển

Tải xuống tệp

GET /esignglobal/v1/envelope/files/download

Mô tả giao diện

Chỉ hỗ trợ tải xuống các tệp bên trong phong bì dưới dạng gói nén khi phong bì đã hoàn tất.

Tham số yêu cầu

Tên tham số

Loại

Bắt buộc

Mô tả

envelopeId

string

true

ID phong bì

downloadType

stringfalse

Loại định dạng tải xuống tệp:  

  • zip (mặc định): trả về đường dẫn tải xuống tệp 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ố

Loại

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-Đã hoàn thành

3-Đã hết hạn

5-Đã hủy

downloadUrl

string

Đường dẫn tải tệp

【Lưu ý】Có hiệu lực trong 30 phút, sau khi hết hạn vui lòng gọi lại API để lấy đường dẫn tải xuống

Trả về khi downloadType=zip

envelopeFiles

array

Danh sách tệp trong phong bì

Danh sách tệp trong phong bì

【Lưu ý】Trả về khi downloadType=list

 

fileType

string

Loại tệp

CONTRACT-Tài liệu ký

ATTACHMENT-Tệp đính kèm

CERTIFICATE-Chứng chỉ

COMBINED-Tệp PDF hợp nhất “Tài liệu ký” và “Chứng nhận hoàn tất ký”, trả về khi bật tùy chọn “Tải xuống tệp gói thư hợp nhất”

 

fileName

string

Tên tệp

 

downloadUrl

string

Đường dẫn tải xuống tệp (có hiệu lực trong 60 phút)

Ví dụ phản hồi

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