GET /esignglobal/v1/envelope/files/download
接口描述
仅在信封已完成时,支持打包信封内的文件下载。
请求参数
参数名称 | 类型 | 必填 | 说明 |
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-已过期 4-已拒签 5-已撤销 |
downloadUrl | string | 文件下载地址 【注意】30分钟内有效,过期后请重新请求接口获取下载地址 当downloadType=zip时返回 |
envelopeFiles | array | 信封文件集合 信封文件集合 【注意】当downloadType=list时返回 |
| fileType | string | 文件类型 CONTRACT-签署文件 ATTACHMENT-附件 CERTIFICATE-证书 COMBINED-合并了“签署文件”与“签署完成证明”的PDF文件,当“信封文件合并下载”开启时返回 |
| fileName | string | 文件名称 |
| downloadUrl | string | 文件下载地址(60分钟内有效) |
响应示例
{
"code": "0",
"data": {
"envelopeId": "xxxx",
"downloadUrl": "下载地址",
"envelopeStatus": 2
},
"message": "success"
}