下載檔案

GET /esignglobal/v1/envelope/files/download

接口描述

信封簽署中或已完成時，支援下載信封內的檔案。簽署中下載受流程下載配置、下載權限與檔案可見性規則約束；若簽署中檔案需要浮水印異步合成，介面返回下載任務 ID，客戶可透過下載任務查詢介面或下載任務完成回調獲取檔案結果。

請求參數

參數名稱	類型	必填	說明
envelopeId	string	true	信封 ID
downloadType	string	false	檔案下載格式類型： zip（預設）：返回壓縮包下載連結 list：返回檔案列表

請求範例

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

回應參數

參數名稱		類型	說明
envelopeId		string	信封 ID
envelopeStatus		int	信封狀態 0-已創建（草稿） 1-簽署中 2-已完成 3-已過期 5-已撤銷
taskId		string	下載任務 ID。僅信封簽署中且文件需要水印異步合成時返回。【注意】返回 taskId 時，不返回 downloadUrl、envelopeFiles 等文件結果字段。
downloadUrl		string	文件下載地址【注意】30分鐘內有效，過期後請重新請求接口獲取下載地址當downloadType=zip，且可同步返回文件結果時返回；返回 taskId 時不返回該字段。
envelopeFiles		array	信封文件集合【注意】當downloadType=list，且可同步返回文件結果時返回；返回 taskId 時不返回該字段。
	fileType	string	檔案類型 CONTRACT-簽署檔案 ATTACHMENT-附件 CERTIFICATE-憑證 COMBINED-合併了「簽署檔案」與「簽署完成證明」的PDF檔案，當「信封檔案合併下載」開啟時返回
	fileName	string	檔案名稱
	downloadUrl	string	檔案下載地址（60分鐘內有效）

回應範例

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

簽署中且檔案需要浮水印異步合成時，回應範例如下：

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