下载签署中文件

更新时间：2023-10-27 15:32:40

接口描述

通过该接口可以下载流程正在签署中的文件进行预览查看，用于开发者内部系统展示合同内容。本接口下载的文件因为是过程中文件所以不支持验签和出证，并且文件中会带有“本文档仅供预览查看”的水印字样。样式参考下图：

接口地址&请求方法

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

请求方法：GET

请求头格式

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

请求参数

参数名称

参数类型

必选

参数位置

参数说明

signFlowId

string

是

path

签署中状态的签署流程ID

docFileId

string

是

query

本次签署流程中的文件ID

【注】仅支持签署文件，不支持附件

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖message 匹配，因为 message 可能会调整。
data（点击“+”展开详情）		object	否	业务数据
	fileId	string	否	文件ID
	fileName	string	否	文件名称
	fileDownloadUrl	string	否	签署中文件下载链接（有效期为60分钟，过期后可以重新调用接口获取新的下载地址）

请求示例

GET https://openapi.esign.cn/v3/sign-flow/c57fb***88afb7b97d5/preview-file-download-url?docFileId=a24a7***d2406eb23

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "fileId": "a24a751b57394115af322ced2406eb23",
        "fileName": "11.pdf",
        "fileDownloadUrl": "https://esignoss.esign.cn/1111564182/24585d36-6f4b-****-97d0-9d9b039297e1/%E9%94%80%E5%94%AE%E5%90%88%E5%90%8C.pdf?Expires=1698318711&OSSAccessKeyId=LTAI4G23YViiKnxTC28ygQzF&Signature=QR%2FMabb66UA0fjPjEV2JJbCCfuE%3D"
    }
}

错误码

点击查看错误码