查询PDF文件详情

更新时间：2022-04-08 10:38:32

文档变更说明

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

接口描述

查看内容填写后文件的当前状态、文件名称、文件大小和下载链接，本接口不支持轮询。

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

接口地址&请求方式

接口地址：/v1/files/{fileId}

请求方式：GET

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

参数名称

类型

必选

参数类型

参数说明

fileId

string

是

path

文件ID

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

响应参数

展开全部参数参数名称		类型	必选	参数说明
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	否	PDF文件下载链接（有效性60分钟）
	pdfTotalPages	int	否	pdf文件总页数,仅当文件类型为pdf时有值

请求示例

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	获取合同下载地址失败	这个一般是客户只得到了文件上传地址，还没上传文件，就去查询文件详情了，正确的步骤：获取文件上传地址----->上传文件，然后在查询文件详情