查询PDF文件详情

更新时间：2022-11-11 03:15:52

文档变更说明

原接口的中文名称由“查询文件详情/下载文件”变更为“查询PDF文件详情”，其接口功能未做调整。

接口描述

查看所上传文件的当前状态、文件名称、文件大小和下载链接，本接口不支持轮询。

当接口返回的文件状态 status 值为 2 或 5 时，此文件才可以被正常添加到签署流程中或下载PDF文件。

接口地址

/v1/files/{fileId}

请求方法

GET

请求头

提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。

方式一：请求签名鉴权（优先推荐）

请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	项目ID
Content-Type	string	是	application/json;charset=UTF-8
X-Tsign-Open-Ca-Timestamp	string	是	API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击
Accept	string	是	建议统一填写 /
X-Tsign-Open-Ca-Signature	string	是	签名字符串
Content-MD5	string	是	当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。
X-Tsign-Open-Auth-Mode	string	是	选择请求方式进行鉴权，固定值，Signature

方式二：OAuth2.0鉴权（不推荐使用）

当安全接入选择OAuth2.0鉴权方式，请点击查阅详情，请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	项目ID
X-Tsign-Open-Token	string	是	通过获取鉴权Token接口返回
Content-Type	string	是	application/json; charset=UTF-8

请求参数

参数名称

类型

必选

参数类型

参数说明

fileId

string

是

path

文件id，该参数需放在请求地址里面，可以参考【请求示例】

pageSize

boolean

否

query

是否返回文件首页的长宽值，默认值 false

true - 返回长宽值

false - 不返回长宽值（字段会返回，值为null）

响应参数

展开全部参数参数名称		类型	必选	参数说明
code		int	是	业务码，0表示成功
message		string	否	信息
data		object	否	业务信息
	fileId	string	否	文件ID
	name	string	否	文件名称
	size	int	否	文件大小（预留字段，暂时不会返回任何值，开发者可忽略）
	status	int	否	文件上传状态 0-文件未上传； 1-文件上传中； 2-文件上传已完成； 3-文件上传失败； 4-文件等待转pdf ； 5-文件已转换pdf ； 6-加水印中； 7-加水印完毕； 8-文件转换中； 9-文件转换失败
	downloadUrl	string	否	下载地址，一般有效期为1个小时
	pdfTotalPages	int	否	pdf文件总页数,仅当文件类型为pdf时有值
	pageWidth	float	否	首页宽度，单位：像素（px）【注】pageSize传true才返回具体值
	pageHeight	float	否	首页高度，单位：像素（px）【注】pageSize传true才返回具体值

请求示例

GET https://openapi.esign.cn/v1/files/{fileId}

响应示例

{
    "code": 0,
    "data": {
        "fileId": "xxx",
        "name": "xxx",
        "size": null,
        "status": 0,
        "downloadUrl": "xxx",
        "pdfTotalPages":4
    },
    "message": ""
}

错误码

错误码	错误描述	解决方案
1430603	获取合同下载地址失败	这个一般是客户只得到了文件上传地址，还没上传文件，就去查询文件详情了，正确的步骤：获取文件上传地址----->上传文件，然后在查询文件详情