合同详情

接口说明

仅返回当前 key 创建的合同。signUrl / h5SignUrl 的返回条件与列表相同：合同为 signing 且链接尚未失效。

请求地址：/open/v1/contracts/{contractId}

请求方式：GET

在线调试

请求参数

每个请求须携带请求头 X-Api-Key。

参数名称	数据类型	必须	说明
contractId	string	是	合同 ID，路径参数

响应参数

参数名称	数据类型	必须	说明
code	number	是	0 表示成功
message	string	是	说明
data	object	是	业务数据
contractId	string	是	合同 ID
contractName	string	是	合同名称
status	string	是	合同状态
deadline	string	是	签署截止时间
createdAt	string	是	创建时间
signUrl	string	否	微信小程序签署引导短链
h5SignUrl	string	否	浏览器 H5 签署链接。返回条件同 signUrl
signers	array	是	签署方进度
type	string	是	person 或 company
name	string	否	个人姓名。企业签署方不返回
mobile	string	否	个人手机号。企业签署方不返回
companyName	string	否	企业名称。个人签署方不返回
creditCode	string	否	统一社会信用代码。个人签署方不返回
agentName	string	否	经办人姓名。个人签署方不返回
agentMobile	string	否	经办人手机号。个人签署方不返回
needSeal	boolean	是	是否须盖章
status	string	是	waiting 待开始 approving 待审批 pending 待签署 signed 已完成 refused 已拒签

响应示例

{
  "code": 0,
  "message": "ok",
  "data": {
    "contractId": "ct_20001",
    "contractName": "采购合同",
    "status": "signing",
    "deadline": "2026-11-20 18:00:00",
    "createdAt": "2026-10-27 11:00:00",
    "signUrl": "https://h5.xwkc.com/r8k2mQ",
    "h5SignUrl": "https://m.xwkc.com/#/ePackage/pages/contractDetail/index?taskId=ct_20001&sceneCon=personShare",
    "signers": [
      {
        "type": "company",
        "companyName": "示例科技有限公司",
        "creditCode": "91310000MA1EXAMPLE",
        "agentName": "张三",
        "agentMobile": "13800000001",
        "needSeal": true,
        "status": "pending"
      },
      {
        "type": "person",
        "name": "李四",
        "mobile": "13900000002",
        "needSeal": true,
        "status": "waiting"
      }
    ]
  }
}