接口描述
查询文件在e签宝服务端的上传状态。
1. 查看所上传文件的当前状态（转换pdf/html文件状态）文件名称和下载链接。
2. 当返回的文件状态status值为 2 或 5 时，此文件才可以被应用到签署流程中。
接口地址&请求方法
接口地址：https://{host}/v3/files/{fileId}
请求方法：GET
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
fileId | string | 是 | path | 文件ID |
pageSize | boolean | 否 | query | 是否返回文件首页的长宽值，默认值 false true - 返回长宽值 false - 不返回长宽值（字段会返回，值为null） |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖 message 匹配，因为 message 可能会调整。 | |
data（点击“+”展开详情） | object | 否 | 业务数据 | |
fileId | string | 否 | 文件ID | |
fileName | string | 否 | 文件名称 | |
fileSize | int32 | 否 | 文件大小（预留字段，暂时不会返回任何值，开发者可忽略） | |
fileStatus | int32 | 否 | 文件状态 0 - 文件未上传 1 - 文件上传中 2 - 文件上传已完成 或 文件已转换（HTML） 3 - 文件上传失败 4 - 文件等待转换（PDF） 5 - 文件已转换（PDF） 6 - 加水印中 7 - 加水印完毕 8 - 文件转化中（PDF） 9 - 文件转换失败（PDF） 10 - 文件等待转换（HTML） 11 - 文件转换中（HTML） 12 - 文件转换失败（HTML） 【注】文件添加水印功能仅e签宝SaaS高级版支持，具体功能如何接入请联系对接技术指导 | |
fileDownloadUrl | string | 否 | 文件下载地址（有效期为60分钟，过期后可以重新调用接口获取新的下载地址） | |
fileTotalPageCount | int32 | 否 | pdf文件总页数 | |
pageWidth | float | 否 | 首页宽度，单位：像素（px） 【注】pageSize传true才返回具体值 | |
pageHeight | float | 否 | 首页高度，单位：像素（px） 【注】pageSize传true才返回具体值 | |
请求示例
GET https://openapi.esign.cn/v3/files/cbd1***qwe响应示例
{
"code": 0,
"message": "成功",
"data": {
"fileId": "cbd1***qwe",
"fileName": "房屋租赁协议.pdf",
"fileSize": null,
"fileStatus": 2,
"fileDownloadUrl": "https://esignoss.esign.cn/1111564182/6e4c2df8-***-ec781e2ae849/%E5%90%8C.pdf?Expires=***&OSSAccessKeyId=***&Signature=***",
"fileTotalPageCount": 4,
"pageWidth": null,
"pageHeight": null
}
}
我要纠错