电子合同API开发文档 v5

获取合同状态

接口地址:https://api.1dq.com/v5/Contracts/getWordsStatus.json

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

在线工具:API在线调试接口

接口描述:
获取合同状态

请求参数

除去下列参数中,需要在header中添加公共参数,详见公共请求参数

参数名 是否必填 长度 类型 默认值 描述 示范
words_id - STRING -
文档的id
11529272-d742-11ea-a75a-0242ac110011
easy_id 18 STRING -
会员的id,如果传递会返回signed_status 签署状态
175592531139104768
open_id - STRING -
会员的id,如果传递会返回signed_status 签署状态
9e4568dc-a3fb-11ea-864b-0242ac110003

请求示范

 POST https://api.1dq.com/v5/Contracts/getWordsStatus.json
 {
    "easy_id": "175592531139104768",
    "words_id": "11529272-d742-11ea-a75a-0242ac110011"
}

返回结果

参数名 是否必填 长度 类型 默认值 描述 示范
code 1-10 long 业务状态码 200
msg 2-64 string 结果描述 请求成功
data - 结果集 -

----status

- STRING 合同状态描述,1 待我签署、3 待他人签、4 已完成、5 已拒签、6 已过期、7 已撤回、8 草稿箱、9 待我填写、10 待他人填写、11 待设置签署区、12 已作废

----signed_status

- STRING 当前用户签署状态 1 待签署,2已完成

----original_status

- INT 合同状态

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "status": "待我签署",
        "original_status": 1,
        "signed_status": 1
    }
}

失败示范

{
    "code": 106,
    "msg": "获取机构信息失败",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码