接口描述
通过此接口可以获取签署人对应的签署流程（签署中与已完成），以便开发者能够快速获取到批量签署的流程ID。
接口地址
/v3/sign-flow/batch-sign-list
请求方式
POST
请求头
方式一：请求签名鉴权（优先推荐）
当接口调用选择请求签名鉴权方式，点击查看详细说明。
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-Auth-Mode | string | 是 | 接口鉴权方式，请填写固定值Signature |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
X-Tsign-Open-Ca-Signature | string | 是 | 请求签名值，查看请求签名值计算说明。 |
X-Tsign-Open-Ca-Timestamp | string | 是 | 接口调用时的Unix时间戳，单位毫秒。 防重放攻击，时间戳有效期为15分钟。 |
Content-MD5 | string | 是 | 当请求Body体为非Form格式时，需要对Body体计算ContentMD5并传给网关进行校验。 application/json格式的Body体时此项必选。 |
Content-Type | string | 是 | application/json; charset=UTF-8 |
Accept | string | 是 | 建议统一填写 */* |
方式二：OAuth2.0鉴权（不推荐使用）
当接口调用选择OAuth2.0鉴权方式，请点击查看具体请求头。
请求参数
展开全部参数参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | |
pageNum | int | 是 | body | 页码（大于0，最小值为1） | |
pageSize | int64 | 是 | body | 每页展示的数量（可选范围[1~100]） | |
signFlowStartTimeFrom | int64 | 是 | body | 开始时间（流程发起时间） 毫秒级时间戳格式 | |
signFlowStartTimeTo | int64 | 是 | body | 结束时间（流程发起时间）毫秒级时间戳格式 （开始时间到结束时间的时间范围最长不可超过90天） | |
signerInfos | array | 否 | body | 参与签署流程的账号列表信息 | |
operatorId | string | 否 | body | 操作人账号ID | |
signerId | string | 否 | body | 签署方账号ID | |
signFlowStatus | array | 否 | body | 流程状态列表（默认全部） 1 : 签署中 2 : 已完成 | |
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | |||
code | int | 是 | 业务码，0表示成功 | |||
message | string | 是 | 信息 | |||
data | object | 否 | 业务信息 | |||
total | int64 | 否 | 查询总数 | |||
signFlowInfos | array | 否 | 流程列表 | |||
initiatorInfo | object | 否 | 签署流程发起方信息 | |||
belongerId | string | 否 | 发起方主体账号ID | |||
belongerName | string | 否 | 发起方主体名称 | |||
initiatorId | string | 否 | 发起方账号ID | |||
initiatorName | string | 否 | 发起方账号名称 | |||
signerInfos | array | 否 | 流程参与签署账号列表 | |||
operatorId | string | 否 | 操作人账号ID | |||
operatorName | string | 否 | 操作人名称 | |||
signerId | string | 否 | 签署方账号ID | |||
signerName | string | 否 | 签署方名称 | |||
signFlowId | string | 否 | 签署流程ID | |||
signFlowStartTime | int64 | 否 | 流程开始时间 | |||
signFlowEndTime | int64 | 否 | 流程结束时间 | |||
signFlowStatus | int32 | 否 | 签署流程状态 1 : 签署中 2 : 已完成 | |||
signFlowTitle | string | 否 | 签署主题 | |||
请求示例
POST https://openapi.esign.cn/v3/sign-flow/batch-sign-list
{
"pageNum":1,
"pageSize":100,
"signFlowStartTimeFrom":16437xx350000,
"signFlowStartTimeTo":164xx750000,
"signFlowStatus":[1],
"signerInfos":[
{
"operatorId":"c7e0029472914ce4ab33deea31054xx",
"signerId":"0c5bd492486b47f58d4ba96d564xx"
}
]
}响应示例
{
"code": 0,
"message": "成功",
"data": {
"total": 2,
"signFlowInfos": [
{
"signFlowTitle": "xx劳动合同签署",
"signFlowId": "930e1bc9231848c2a7d5e6c7c84xx",
"signFlowStartTime": 1644289669091,
"signFlowEndTime": 1644289722000,
"signFlowStatus": 1,
"initiatorInfo": {
"initiatorId": "55d29d5ab5c543d98560e4fxx67",
"initiatorName": "esigntestxx测试企业",
"belongerName": "esigntestxx测试企业",
"belongerId": "55d29d5ab5c543d98560e4f714xx7"
},
"signerInfos": [
{
"operatorName": "xxx",
"operatorId": "c7e0029472914ce4ab33dexxe7",
"signerName": "esigntestxx企业",
"signerId": "0c5bd492486b47f58d4ba9xxbfbf"
}
]
},
{
"signFlowTitle": "xx人力资源合同签署",
"signFlowId": "95a39636c930409ba53a4722749xx4",
"signFlowStartTime": 1644289973693,
"signFlowEndTime": 1644290027000,
"signFlowStatus": 1,
"initiatorInfo": {
"initiatorId": "55d29d5ab5c543d98560e4fxx7",
"initiatorName": "esigntestxx测试企业",
"belongerName": "esigntestxx测试企业",
"belongerId": "55d29d5ab5c543d98560e4f7xx7"
},
"signerInfos": [
{
"operatorName": "xxx",
"operatorId": "c7e0029472914ce4ab33dexx1e7",
"signerName": "esigntestxx企业",
"signerId": "0c5bd492486b47f58d4baxxxbfbf"
}
]
}
]
}
}
我要纠错