查询文件上传状态

更新时间:2022-01-24 00:12:42

文档变更

2022年时,查询文件上传状态变为查询文件上传状态,仅中文名称变更,其功能保持不变。

接口描述

查看所上传文件的当前状态,本接口支持轮询。

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

接口地址&请求方式

接口地址:/v1/files/{fileId}/status

请求方式:GET

请求头格式

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

请求参数

参数名称

类型

必选

参数类型

参数说明

(左右拖动查看完整描述)

fileId

string

path

文件ID

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

响应参数

展开全部参数参数名称

类型

必选

参数说明

(左右拖动查看完整描述)

code

int

业务码,0表示成功

message

string

业务信息

data

object

业务数据

status

int

文件状态

0-文件未上传

1-文件上传中

2-文件上传已完成

3-文件上传失败

4-文件等待转pdf

5-文件已转换pdf

6-加水印中

7-加水印完毕

8-文件转换中

9-文件转换失败

请求示例  

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

响应示例

{
    "code": 0,
    "data": {
        "status": 0    
    },
    "message": ""
}

错误码

错误码

错误描述

排查方法

(左右拖动查看完整描述)

1430613

查询合同上传状态失败: 合同不存在

1、确认文件id是否存在

2、确认文件id和appid所属环境是否一直

我要纠错