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

Tải xuống tập tin

GET /esignglobal/v1/envelope/files/download

Mô tả giao diện

Chỉ khi phong bì đã hoàn thành, mới hỗ trợ đóng gói các tệp trong phong bì để tải xuống.

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ề 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ố

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

4-Đã từ chối ký

5-Đã thu hồi

downloadUrl

string

Địa chỉ tải xuống tệp

【Lưu ý】Có hiệu lực trong vòng 30 phút, vui lòng yêu cầu lại giao diện để lấy địa chỉ tải xuống sau khi hết hạn

Trả về khi downloadType=zip

envelopeFiles

array

Tập hợp các tệp phong bì

Tập hợp các tệp 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ỉ

 

fileName

string

Tên tệp

 

downloadUrl

string

Địa chỉ 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"
}

 

Mô tả giao diện
Tham số yêu cầu
Ví dụ yêu cầu
Tham số phản hồi
Ví dụ phản hồi