查询文件上传状态

更新时间:2021-07-04 17:36:04

接口描述

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

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

接口地址

/v1/files/{fileId}/status

请求方法

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该参数需放在请求地址里面,可以参考【请求示例】


响应参数

展开全部参数参数名称

类型

必选

参数说明

示例值

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所属环境是否一直


我要纠错