下载文件

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"
}