电子合同API开发文档 v5

查询合同详情

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

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

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

接口描述:
查询合同详情

请求参数

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

参数名 是否必填 长度 类型 默认值 描述 示范
words_id 36 STRING -
文档id
58b1f99a-ab01-11ea-82be-0242ac110004

请求示范

 POST https://api.1dq.com/v5/Contracts/read.json
 {
    "words_id": "58b1f99a-ab01-11ea-82be-0242ac110004"
}

返回结果

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

----name

- STRING 合同名称

----count_pages

- INT 合同页数

----signed_url

- STRING 签署链接

----status

- STRING 状态

----status_pdf

- STRING 是否转换pdf 1为正常

----sign_end_date

- STRING 签署截止日期

----file_end_date

- STRING 文件到期时间

----create_time

- STRING 创建时间

----update_time

- STRING 最后更新时间

----sender_name

- STRING 发起人

----recipient_name

- STRING 收件人

----attachment

- ARRAY 附件列表

--------file_name

- STRING 附件名称

--------file_url

- STRING 附件下载地址

--------file_id

- STRING 附件Id

----signed_file

- ARRAY 需要签署的文件

--------file_name

- STRING 需要签署的文件的名称

--------file_url

- STRING 需要签署文件的下载地址

--------file_id

- STRING 需要签署文件的Id

----pages

- ARRAY 图片列表

--------url

- STRING 下载地址

--------signed_data

- OBJECT 保留字段

--------place_data

- OBJECT 保留字段

----logs

- ARRAY 流程

--------content

- STRING 流程内容

--------create_time

- STRING 流程发生时间

----sign

- ARRAY 签署人列表

--------sign_class

- STRING 签署类型,1个人,2企业

--------sign_name

- STRING 签署名称

--------sign_company

- STRING 签署公司名称

--------real_status

- STRING 实名状态

--------org_id

- STRING 个人或机构的id

--------status

- STRING 是否签署

----copy

- ARRAY 抄送人列表

--------sign_class

- STRING 抄送类型,1个人,2企业

--------sign_name

- STRING 抄送人个人名称

--------sign_company

- STRING 抄送人公司名称

--------real_status

- STRING 实名状态

--------org_id

- STRING 个人或机构的id

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "name": "项目合同协议",
        "count_pages": 6,
        "signed_url": "http:\/\/1dq.co\/u\/GG4eL4",
        "status": "待我签署",
        "status_pdf": 1,
        "sign_end_date": "长期",
        "file_end_date": 0,
        "create_time": "2020-06-10 18:01:27",
        "update_time": "2020-06-10 22:45:28",
        "sender_name": "测试机构011",
        "recipient_name": null,
        "need_password": -1,
        "attachment": [
            {
                "file_name": "附件1",
                "file_url": "https:\/\/safe-storage.1dq.com\/signed\/efb2124360fb5f8b109220e27f99ae35\/73ff845c.png?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=t%2BWSiG4yTZ6MUOz2fMYcOIWRasY%3D",
                "file_id": "signed-efb2124360fb5f8b109220e27f99ae35-73ff845c-0006"
            },
            {
                "file_name": "附件2",
                "file_url": "https:\/\/safe-storage.1dq.com\/signed\/efb2124360fb5f8b109220e27f99ae35\/73ff845c.png?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=t%2BWSiG4yTZ6MUOz2fMYcOIWRasY%3D",
                "file_id": "signed-efb2124360fb5f8b109220e27f99ae35-73ff845c-0006"
            }
        ],
        "signed_file": {
            "file_id": "signed-ce5858499044c9b8fbbaa272754c145a-108d9e29-0001",
            "file_url": "https:\/\/safe-storage.1dq.com\/signed\/ce5858499044c9b8fbbaa272754c145a\/pdf\/108d9e29.pdf?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=zP%2FcPNaEcgq%2FYpYzQGkrRHq3SbI%3D",
            "file_name": "安全服务合同模板.docx"
        },
        "pages": [
            {
                "url": "https:\/\/safe-storage.1dq.com\/signed\/ce5858499044c9b8fbbaa272754c145a\/png\/108d9e29-0.png?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=cmfRf7pnm3jPE3ispTCyobIuDTE%3D",
                "signed_data": [],
                "place_data": []
            },
            {
                "url": "https:\/\/safe-storage.1dq.com\/signed\/ce5858499044c9b8fbbaa272754c145a\/png\/108d9e29-1.png?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=bzuylsXzuBKI7qXwiXI3nqL8gj0%3D",
                "signed_data": [],
                "place_data": []
            },
            {
                "url": "https:\/\/safe-storage.1dq.com\/signed\/ce5858499044c9b8fbbaa272754c145a\/png\/108d9e29-2.png?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=DPAVJBRGaGjCwmJUJFOE2ISX9Nc%3D",
                "signed_data": [],
                "place_data": []
            },
            {
                "url": "https:\/\/safe-storage.1dq.com\/signed\/ce5858499044c9b8fbbaa272754c145a\/png\/108d9e29-3.png?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=VgUSa%2FlawAa%2Ffctgue%2B1WYEBBc0%3D",
                "signed_data": [],
                "place_data": []
            },
            {
                "url": "https:\/\/safe-storage.1dq.com\/signed\/ce5858499044c9b8fbbaa272754c145a\/png\/108d9e29-4.png?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=NEtGKzoruslmhk%2Bdpe5EeNTHX%2FQ%3D",
                "signed_data": [],
                "place_data": []
            },
            {
                "url": "https:\/\/safe-storage.1dq.com\/signed\/ce5858499044c9b8fbbaa272754c145a\/png\/108d9e29-5.png?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591803931&Signature=tZCr0KVQz07x4AGBlVvvLPs0%2FH8%3D",
                "signed_data": [],
                "place_data": []
            }
        ],
        "logs": [
            {
                "content": "18888888881上传了文件",
                "create_time": "2020-06-10 18:01:27"
            }
        ],
        "sign": [
            {
                "sign_class": 2,
                "sign_name": "测试xx",
                "sign_company": "测试机构011",
                "real_status": "未实名",
                "org_id": "de9beeae-a817-11ea-89a2-0242ac110003",
                "status": "未签"
            },
            {
                "sign_class": 2,
                "sign_name": "测试xx",
                "sign_company": "测试机构011",
                "real_status": "未实名",
                "org_id": "de9beeae-a817-11ea-89a2-0242ac110003",
                "status": "未签"
            }
        ],
        "copy": [
            {
                "sign_class": 2,
                "sign_name": "测试xx",
                "sign_company": "测试机构011",
                "real_status": "未实名",
                "org_id": "de9beeae-a817-11ea-89a2-0242ac110003"
            },
            {
                "sign_class": 2,
                "sign_name": "测试xx",
                "sign_company": "测试机构011",
                "real_status": "未实名",
                "org_id": "de9beeae-a817-11ea-89a2-0242ac110003"
            }
        ]
    }
}

失败示范

{
    "code": 404,
    "msg": "您无法访问该资源",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码