合同查询

GET

/open/contract/detail

V1.1.0

查询合同发起时间、签署状态、签署人等合同信息。发起后的合同可以通过此接口查询

可能出现的错误码

错误码	错误信息	解决办法
500	服务繁忙,请重试.	联系客服
400	参数错误.	参数与接口文档进行核对
oc_40006	合同不存在或状态异常	参数核对

请求参数

Query 参数

contractId

string

可选

合同id。contractId和businessCode二选一

示例值:

1920368226253934592

businessCode

string

可选

第三方签署流程业务id。contractId和businessCode二选一。注：需在发起时指定

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'api.pre-qiandun365.com/api/open/contract/detail?contractId=1920368226253934592&businessCode'

返回响应

🟢200成功

application/json

Body

code

string

必需

msg

string

必需

result

object

必需

contractId

number

合同id

必需

contractName

string

合同名

必需

contractStatus

enum<string>

合同状态

必需

枚举值:

wait_signfinishedtimeout

initiator

object

合同发起人

必需

seqSigning

boolean

是否顺序签署

必需

signers

array [object {3}]

签署人

必需

startTime

string

合同发起时间

必需

格式：yyyy-MM-dd

endTime

string | null

合同结束时间

可选

格式：yyyy-MM-dd

finishedTime

string | null

合同签署完成时间

可选

格式：yyyy-MM-dd

signDeadline

string | null

合同签署截止时间

可选

格式：yyyy-MM-dd

evidenceConfig

array[integer] | null

存证配置

可选

枚举值:

success

boolean

必需

logKey

string

必需

number

必需

示例

{
    "code": "string",
    "msg": "string",
    "result": {
        "contractId": 0,
        "contractName": "string",
        "contractStatus": "wait_sign",
        "initiator": {
            "accountId": "string"
        },
        "seqSigning": true,
        "signers": [
            {
                "seqNo": 0,
                "accountId": "string",
                "status": "init"
            }
        ],
        "startTime": "string",
        "endTime": "string",
        "finishedTime": "string",
        "signDeadline": "string",
        "evidenceConfig": [
            3
        ]
    },
    "success": true,
    "logKey": "string",
    "ts": 0
}

下载合同文件及附件

获取合同签署链接（页面）