下载已签署文件及附属材料

更新时间：2025-11-14 15:14:25

接口描述

流程结束后，获取签署完成的文件以及相关附属材料的下载链接。

未签署完成的流程，无法下载相关文件，否则会报错："流程非签署完成状态，不允许下载文档"。

接口地址&请求方法

接口地址：https://{host}/v3/sign-flow/{signFlowId}/file-download-url

请求方法：GET

请求头格式

具体请求头参数，请查看公共请求头格式。

请求参数

参数名称

参数类型

必选

参数位置

参数说明

signFlowId

string

是

path

已完成状态的签署流程ID

urlAvailableDate

int

否

query

下载链接有效期，单位：秒。默认：3600秒（60分钟）

可传入：1-3600

补充说明：

为链接设置有效期是一项安全措施，旨在降低因无关人员访问而导致的信息泄露风险。

响应参数

展开全部参数参数名称			参数类型	必选	参数说明
code			int32	是	业务码，0表示成功，非0表示异常。
message			string	否	业务信息请根据 code 来判断错误情况，不应该依赖message 匹配，因为 message 可能会调整。
data（点击“+”展开详情）			object	否	业务数据
	files（点击“+”展开详情）		array	否	签署文件信息
		fileId	string	否	签署文件ID
		fileName	string	否	签署文件名称
downloadUrl		string	否	已签署文件下载链接（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址）
attachments（点击“+”展开详情）		array	否	附属材料信息
	fileId	string	否	附属材料文件ID
	fileName	string	否	附属材料文件名称
	downloadUrl	string	否	附属材料文件下载链接（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址）
certificateDownloadUrl		string	否	海外签证书报告下载地址（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址）【注】默认中国大陆签署不返回值

请求示例

GET https://openapi.esign.cn/v3/sign-flow/b2cb7**3cc54/file-download-url?urlAvailableDate=3600

响应示例

{
  "code": 0,
  "message": "成功",
  "data": {
    "files": [
      {
        "fileId": "0e99dee27**b2cd69",
        "fileName": "xx企业劳动合同签署.pdf",
        "downloadUrl": "https://esignoss.esign.cn/1111563786/8446a910-1252-4712-84e6-5fe17beb7db6/%E5%BC%80%E5%8F%91%E5%89%8D%E5%BF%85%E8%AF%BB.pdf?Expires=1649935695&OSSAccessKeyId=LTAI4G23YViiKnxTC28ygQzF&Signature=xx%3D"
      }
    ],
    "attachments": [
      {
        "fileId": "e2774d28**b4e55180",
        "fileName": "入职材料.pdf",
        "downloadUrl": "https://esignoss.esign.cn/1111564182/37afade5-84eb-497c-8068-909487f5cc41/%E5%BC%80%E5%8F%91%E5%89%8D%E5%BF%85%E8%AF%BB.pdf?Expires=1649935695&OSSAccessKeyId=LTAI4G23YViiKnxTC28ygQzF&Signature=1KtvhoMUi%2B1k%x%3D"
      }
    ],
    "certificateDownloadUrl": null
  }
}

错误码

点击查看错误码