电子合同API开发文档 v5

查询合同列表

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

请求方式：POST

参数位置：body

权限控制：支持

接口版本： v5.0

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

接口描述：
查询账户内合同的列表

请求参数

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

参数名 是否必填 长度 类型 默认值 描述 示范
easy_id 是 18 STRING -
会员的easy_id，或您总账户的easy_id
175592531139104768
archive_id 否 - LONG -
归档id
class_id 否 - STRING all
全部文件=all，待我签署=signed，待他人签=signedToBe，已完成=complete，已拒签=avisa，已过期=expired，已撤回=withdraw，草稿箱=draft，待我填写=fillMy，待他人填写=others，待设置签署区=signArea，
others
keyword 否 - STRING -
关键词
limit 否 - INT -
每页数量
page 否 - INT -
分页
recipient_name 否 - STRING -
收件人
sender_name 否 - STRING -
发起人

请求示范

 POST https://api.1dq.com/v5/Contracts.json
 {
    "archive_id": "",
    "class_id": "others",
    "easy_id": "175592531139104768",
    "keyword": "",
    "limit": "",
    "page": "",
    "recipient_name": "",
    "sender_name": ""
}

返回结果

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

----name

 否 - STRING 合同名称

----words_id

 否 - STRING 文档id

----sender_name

 否 - STRING 发起人

----recipient_name

 否 - STRING 收件人

----down_url

 否 - STRING 合同下载地址，签署成功后返回

----signed_url

 否 - STRING 签署地址

----archive_id

 否 - STRING 归档id

----ledger

 否 - STRING 台账数据

----ledger_id

 否 - STRING 台账id

----thumbnail

 否 - STRING 缩略图

----create_time

 否 - STRING 创建时间

----words_status

 否 - STRING 合同状态，4为签署成功 其他为:: 1待我签署,3待他人签,4已完成,5已拒签,6已过期,7已撤回,8草稿箱,9待我填写,10待他人填写,11待设置签署区

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "total": 36,
        "current_page": 1,
        "last_page": 3,
        "per_page": 15,
        "data": [
            {
                "name": "xxxx劳务协议",
                "words_id": "ffde9fc2-xxx-11eb-899d-024215000502",
                "sender_name": "上海某某有限公司",
                "recipient_name": "19961580024",
                "down_url": "",
                "signed_url": "http:\/\/1dq.co\/u\/1ubzb5",
                "archive_id": "",
                "ledger": [],
                "ledger_id": "",
                "thumbnail": "https:\/\/safe-storage-cos2.1dq.com\/signed\/eabb5ad1a7ce0d45fc8c5faade5f70c2\/png\/8618998d-1.jpg?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID1oUyEJ7WEjzIJ2cuSt4ybw0mgJfjIC5s%26q-sign-time%3D1614600445%3B1614601105%26q-key-time%3D1614600445%3B1614601105%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D4c36109ec8f0b52ae9c80e6216087e67bf695acc&imageMogr2\/thumbnail\/80x",
                "create_time": 1611556737,
                "words_status": 1
            }
        ]
    }
}

失败示范

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码