合同列表

描述

使用此接口获取电子合同列表。

接口说明

授权对象 APP

请求地址 GET /open/agreement/list

请求规则 请查阅开发必读

请求参数

参数名称	变量名称	参数类型[长度限制]	是否必填	描述
页码	page	int64	否	默认为1，最小为1 示例值：1
每页数量	limit	int64	否	默认为20，最大为100 示例值：20
时间类型	timeType	int32	否	0 发起时间 1 签署时间 示例值：1
开始时间	startAt	int64	否	时间戳 示例值：1639440000
结束时间	endAt	int64	否	时间戳 示例值：1639526400
流程状态	flowStatus	int32[]	否	合同流程状态 示例值：[1,2]
关键词类型	keywordType	int32	否	0 机构名称 1 个人手机号 示例值：1
关键词	keyword	string	否	示例值：BOOL电子合同

请求示例

{
  "page": 1,
  "limit": 20,
  "timeType": 1,
  "startAt": 1639440000,
  "endAt": 1639526400,
  "flowStatus": [1, 2],
  "signStatus": [1, 2],
  "keywordType": 1,
  "keyword": "BOOL电子合同"
}

响应参数

参数名称	变量名称	参数类型	是否必填	描述
合同列表	signFlowInfos	object[]	是	合同信息列表
总数量	total	int64	是	示例值：100
授权链接	authUrl	string	否	可选，需要授权时返回 示例值：https://boolc.cn/auth

合同信息 signFlowInfos

参数名称	变量名称	参数类型	是否必填	描述
合同ID	signFlowId	string	是	示例值：BOOL_FLOW_123456
开始时间	signFlowStartTime	int64	是	时间戳 示例值：1639440000
结束时间	signFlowEndTime	int64	是	时间戳 示例值：1639526400
合同标题	signFlowTitle	string	是	示例值：BOOL电子合同
合同状态	signFlowStatus	int32	是	示例值：1
撤销状态	rescissionStatus	int32	是	示例值：0
签署人列表	signers	object[]	是	签署人信息列表

签署人信息 signers

参数名称	变量名称	参数类型	是否必填	描述
个人签署方	psnSigner	object	否	个人签署方信息
企业签署方	orgSigner	object	否	企业签署方信息
签署顺序	signOrder	int32	是	示例值：1
签署状态	signStatus	int32	是	示例值：1

个人签署方 psnSigner

参数名称	变量名称	参数类型	是否必填	描述
个人ID	psnId	string	是	示例值：BOOL_PSN_123456
姓名	name	string	是	示例值：BOOL
账户信息	psnAccount	object	是	个人账户信息

个人账户信息 psnAccount

参数名称	变量名称	参数类型	是否必填	描述
手机号	accountMobile	string	是	示例值：13024777828
邮箱	accountEmail	string	否	示例值：service@boolc.cn

企业签署方 orgSigner

参数名称	变量名称	参数类型	是否必填	描述
企业ID	orgId	string	是	示例值：BOOL_ORG_123456
企业名称	orgName	string	是	示例值：贵州不二云科技有限公司
经办人信息	transactor	object	是	经办人信息，结构同个人签署方

响应示例

{
  "signFlowInfos": [
    {
      "signFlowId": "BOOL_FLOW_123456",
      "signFlowStartTime": 1639440000,
      "signFlowEndTime": 1639526400,
      "signFlowTitle": "BOOL电子合同",
      "signFlowStatus": 1,
      "rescissionStatus": 0,
      "signers": [
        {
          "psnSigner": {
            "psnId": "BOOL_PSN_123456",
            "name": "BOOL",
            "psnAccount": {
              "accountMobile": "13024777828",
              "accountEmail": "service@boolc.cn"
            }
          },
          "signOrder": 1,
          "signStatus": 1
        },
        {
          "orgSigner": {
            "orgId": "BOOL_ORG_123456",
            "orgName": "贵州不二云科技有限公司",
            "transactor": {
              "psnId": "BOOL_PSN_789012",
              "name": "BOOL",
              "psnAccount": {
                "accountMobile": "13024777829",
                "accountEmail": "hr@boolc.cn"
              }
            }
          },
          "signOrder": 2,
          "signStatus": 0
        }
      ]
    }
  ],
  "total": 100,
  "authUrl": "https://boolc.cn/auth"
}