签署任务审批 API

管理企业内部合同用印等审批流程。

签署任务审批

本部分包含用于查询、执行和管理企业内部签署任务审批流程的API接口。

重要提示： 所有签署任务相关的 API 请求，都需要在 HTTP Header 中携带有效的 appId, accessToken, userId (操作人ID), 和 source (来源标识) 作为通用认证参数。关于 source 参数的详细说明和取值，请参考快速开始章节。
POST /signTask/getApprovalList 获取审批管理列表

根据条件分页查询审批任务列表。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring是您的应用ID
accessTokenstring是获取到的有效访问令牌
userIdinteger (int64)是执行此操作的用户ID (操作人)
sourcestring是来源标识 (pc, app, h5, wx, alipay)

请求参数 (Body)

参数名 类型 必填 描述
docQueryType integer (int32) 否 查询类型 (0:待我审批, 1:我已审批, 2:我发起的, 3:我收到的)
approvalType integer (int32) 否 审批类型 (1:合同用章审批, 2:合同审批)
signFlowName string 否 合同名称 (模糊查询)
approvalPsnId integer (int64) 否 审批人ID
initiatorId integer (int64) 否 发起人ID
approvalStatus integer (int32) 否 审批状态 (1:审批中, 2:通过, 3:驳回, 4:撤回, 5:终止)
queryTimeType integer (int32) 否 时间类型 (0:审批发起时间, 1:最新处理时间)
approvalTimeStart string (date-time) 否 开始时间
approvalTimeEnd string (date-time) 否 结束时间
listPageNo integer (int32) 否 页码 (默认1)
listPageSize integer (int32) 否 每页数量 (默认10)

请求示例

CURL
curl -X POST 'https://your-api-host.com/signTask/getApprovalList' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "docQueryType": 0,
  "approvalType": 1,
  "listPageNo": 1,
  "listPageSize": 10
}'

响应参数

参数名 类型 描述
code string 响应码，"0" 表示成功，其他表示错误。
msg string 响应消息。
+data array of object 审批信息列表，数组中每个对象的结构如下 (参考 ApprovalInfoRes)：

响应示例

成功响应 (200 OK) 
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "approvalId": 5001,
      "corpName": "示例公司",
      "approvalCode": "APPR_...",
      "approvalName": "合同用章审批-租赁合同",
      "signFlowId": 12001,
      "signFlowName": "租赁合同-20240315",
      "approvalType": 1,
      "approvalStatus": 1,
      "sealId": 9001,
      "sealName": "公司合同专用章",
      "initiatorName": "张三",
      "flowCreateTime": "2024-03-15T10:00:00.000+0800",
      "createTime": "2024-03-15T10:05:00.000+0800",
      "signerList": [ /* ... 签署人信息 ... */ ]
    }
  ]
}

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误
401 未授权
403 禁止访问
500 服务器内部错误
POST /signTask/getApprovalInfo 获取审批管理详情

获取单个审批任务的详细信息。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring是您的应用ID
accessTokenstring是获取到的有效访问令牌
userIdinteger (int64)是执行此操作的用户ID (操作人)
sourcestring是来源标识 (pc, app, h5, wx, alipay)

请求参数 (Body)

参数名 类型 必填 描述
approvalId integer (int64) 是 需要查询详情的审批申请ID

请求示例

CURL
curl -X POST 'https://your-api-host.com/signTask/getApprovalInfo' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "approvalId": 5001
}'

响应参数

参数名 类型 描述
code string 响应码，"0" 表示成功，其他表示错误。
msg string 响应消息。
+data object 审批信息对象，结构如下 (参考 ApprovalInfoRes)：

响应示例

成功响应 (200 OK) 
{
  "code": "0",
  "msg": "success",
  "data": {
    "approvalId": 5001,
    "corpName": "示例公司",
    "approvalCode": "APPR_...",
    "approvalName": "合同用章审批-租赁合同",
    "signFlowId": 12001,
    "signFlowName": "租赁合同-20240315",
    "approvalType": 1,
    "approvalStatus": 1,
    "sealId": 9001,
    "sealName": "公司合同专用章",
    "initiatorName": "张三",
    "flowCreateTime": "2024-03-15T10:00:00.000+0800",
    "createTime": "2024-03-15T10:05:00.000+0800",
    "signerList": [ /* ... 签署人信息 ... */ ]
  }
}

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误 (如approvalId无效)
401 未授权
403 禁止访问 (无权查看该审批)
404 审批不存在
500 服务器内部错误
POST /signTask/approvalSign 审批合同用章

执行审批操作（通过或驳回）。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring是您的应用ID
accessTokenstring是获取到的有效访问令牌
userIdinteger (int64)是执行此操作的用户ID (操作人)
sourcestring是来源标识 (pc, app, h5, wx, alipay)

请求参数 (Body)

参数名 类型 必填 描述
approvalId integer (int64) 是 审批申请ID
approvalStatus integer (int32) 是 审批结果状态 (2:通过, 3:驳回)
failReason string 否 驳回原因 (approvalStatus为3时建议填写)

请求示例 (审批通过)

CURL
curl -X POST 'https://your-api-host.com/signTask/approvalSign' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: APPROVER_USER_ID' \
-H 'source: pc' \
-d '{
  "approvalId": 5001,
  "approvalStatus": 2
}'

响应参数

参数名 类型 描述
code string 响应码，"0" 表示成功，其他表示错误。
msg string 响应消息。
data object 响应数据，包含操作后流程的信息，结构见 SignFlowProcessRes。

响应示例

成功响应 (200 OK)
{
  "code": "0",
  "msg": "success",
  "data": {
    "flowId": 12001,
    "flowStatus": 1
  }
}

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误 (如状态码无效)
401 未授权
403 禁止访问 (非当前审批人或审批已完成/撤销)
404 审批或流程不存在
500 服务器内部错误
POST /signTask/batchApprovalSign 批量审批合同用章

一次性对多个审批任务执行相同的审批操作（通过或驳回）。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring是您的应用ID
accessTokenstring是获取到的有效访问令牌
userIdinteger (int64)是执行此操作的用户ID (操作人)
sourcestring是来源标识 (pc, app, h5, wx, alipay)

请求参数 (Body)

参数名 类型 必填 描述
(Array Body) array of object 是 包含多个审批操作请求的数组，每个对象结构见 SignFlowApprovalReq

请求示例 (批量通过)

CURL
curl -X POST 'https://your-api-host.com/signTask/batchApprovalSign' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: APPROVER_USER_ID' \
-H 'source: pc' \
-d '[
  {
    "approvalId": 5001,
    "approvalStatus": 2
  },
  {
    "approvalId": 5003,
    "approvalStatus": 2
  }
]'

响应参数

参数名 类型 描述
code string 响应码，"0" 表示成功（可能部分失败），其他表示完全失败。
msg string 响应消息。
+data object 响应数据，包含批量操作的结果统计，结构如下 (参考 SignFlowProcessBatchRes)：

响应示例

成功响应 (200 OK) 
{
  "code": "0",
  "msg": "success",
  "data": {
    "failedCount": 0,
    "successCount": 2,
    "signFlowProcessResps": [
      { "flowId": 12001, "flowStatus": 1 },
      { "flowId": 12008, "flowStatus": 1 }
    ]
  }
}

错误码

HTTP状态码/业务码 描述
200 成功 (可能部分失败，看响应体)
400 请求参数错误
401 未授权
403 禁止访问
500 服务器内部错误
POST /signTask/approvalCancel 撤销审批合同用章

由审批发起人撤销尚未完成的审批流程。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring是您的应用ID
accessTokenstring是获取到的有效访问令牌
userIdinteger (int64)是执行此操作的用户ID (操作人)
sourcestring是来源标识 (pc, app, h5, wx, alipay)

请求参数 (Body)

参数名 类型 必填 描述
approvalId integer (int64) 是 需要撤销的审批申请ID
approvalStatus integer (int32) 是 审批状态，应传入撤销对应的状态码 (通常是 4)
failReason string 否 撤销原因 (可选)

请求示例

CURL
curl -X POST 'https://your-api-host.com/signTask/approvalCancel' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: INITIATOR_USER_ID' \
-H 'source: pc' \
-d '{
  "approvalId": 5002,
  "approvalStatus": 4,
  "failReason": "审批人选择错误"
}'

响应参数

参数名 类型 描述
code string 响应码，"0" 表示成功，其他表示错误。
msg string 响应消息。
data object 响应数据，包含操作后流程的信息，结构见 SignFlowProcessRes。

响应示例

成功响应 (200 OK) 
{
  "code": "0",
  "msg": "success",
  "data": {
    "flowId": 12005,
    "flowStatus": 4 // 流程状态可能更新为撤销相关状态
  }
}

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误
401 未授权
403 禁止访问 (非发起人或审批已完成/已撤销)
404 审批不存在
500 服务器内部错误
POST /signTask/approvalSignAuth 审批合同用章短信/密码认证回调方法

用于在执行审批操作时进行额外的身份认证（短信、密码或人脸识别）。这通常在调用审批接口前或作为审批接口的一部分被调用。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring是您的应用ID
accessTokenstring是获取到的有效访问令牌
userIdinteger (int64)是执行此操作的用户ID (操作人)
sourcestring是来源标识 (pc, app, h5, wx, alipay)

请求参数 (Body)

参数名 类型 必填 描述
approvalId string 是 审批申请ID
authType string 是 认证方式 ('sms', 'pwd', 'face')
verifyCode string 看情况 短信验证码 (authType='sms')
signPwd string 看情况 签署密码 (authType='pwd')
newPwd boolean 否 是否新设置密码 (authType='pwd')
code string 看情况 人脸核身结果码 (authType='face')
orderNo string 看情况 人脸核身订单号 (authType='face')
h5faceId string 看情况 人脸核身H5请求ID (authType='face')
newSign / newSignature string 看情况 人脸核身签名 (authType='face')

请求示例 (密码认证)

CURL
curl -X POST 'https://your-api-host.com/signTask/approvalSignAuth' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: APPROVER_USER_ID' \
-H 'source: pc' \
-d '{
  "approvalId": "5001",
  "authType": "pwd",
  "signPwd": "user_input_password"
}'

响应参数

参数名 类型 描述
code string 响应码，"0" 表示认证成功，其他表示失败。
msg string 响应消息。
data object 响应数据，认证成功时通常为空对象 {}。

响应示例

成功响应 (200 OK)
{
  "code": "0",
  "msg": "success",
  "data": {}
}

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误 (如验证码/密码错误)
401 未授权
403 禁止访问 (非当前审批人)
404 审批不存在
XXX 业务错误 (认证失败、人脸核身失败等)
500 服务器内部错误
POST /signTask/getApprovalSignUrl 获取合同用章审批链接

获取用于在线进行合同用章审批的操作页面链接，适用于嵌入式集成。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring是您的应用ID
accessTokenstring是获取到的有效访问令牌
userIdinteger (int64)是执行此操作的用户ID (操作人)
sourcestring是来源标识 (pc, app, h5, wx, alipay)

请求参数 (Body)

该接口通常需要指定要审批的 `approvalId` 或 `flowId`，但提供的 JSON 文件中未定义请求体。请根据实际情况或联系技术支持确认所需参数。通常需要审批人ID (userId) 来获取其待办审批链接。

参数名 类型 必填 描述
approvalId 或 flowId integer (int64) 是 需要获取审批链接的审批ID或流程ID。

请求示例

CURL
# 假设需要 approvalId
curl -X POST 'https://your-api-host.com/signTask/getApprovalSignUrl' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: APPROVER_USER_ID' \
-H 'source: pc' \
-d '{
  "approvalId": 5001
}'

响应参数

参数名 类型 描述
code string 响应码，"0" 表示成功，其他表示错误。
msg string 响应消息。
data string 返回的在线审批页面URL。

响应示例

成功响应 (200 OK) 
{
  "code": "0",
  "msg": "success",
  "data": "https://your-system-ui.com/approval?approvalId=5001&token=..."
}

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误
401 未授权
403 禁止访问 (非当前审批人或状态错误)
404 审批或流程不存在
500 服务器内部错误

共享数据模型参考

以下是本页API请求和响应中涉及的复杂数据结构的详细定义，供参考。

审批查询请求 (`ApprovalQueryReq`)

用于查询审批列表的参数。

参数名 类型 描述
docQueryType int32 查询类型 (0:待我审批, 1:我已审批, 2:我发起的, 3:我收到的)
approvalType int32 审批类型 (1:用章, 2:合同)
signFlowName string 合同名称
approvalStatus int32 审批状态 (1:审批中, 2:通过, 3:驳回, 4:撤回, 5:终止)
listPageNo int32 页码
listPageSize int32 每页数量
... ... 其他查询条件见JSON

审批详情查询请求 (`ApprovalInfoQueryReq`)

参数名 类型 描述
approvalId int64 审批申请ID

审批操作请求 (`SignFlowApprovalReq`)

用于执行审批、撤销审批。

参数名 类型 描述
approvalId int64 审批申请ID
approvalStatus int32 目标审批状态 (2:通过, 3:驳回, 4:撤回)
failReason string 驳回/撤销原因 (可选)

审批认证请求 (`SignFlowApprovalVerifyReq`)

用于审批时的身份认证。

参数名 类型 描述
approvalId string 审批申请ID
authType string 认证方式 ('sms', 'pwd', 'face')
verifyCode string 短信验证码
signPwd string 签署密码
... ... 人脸识别相关参数见JSON

审批信息响应 (`ApprovalInfoRes`)

查询审批列表或详情时返回的对象结构。

参数名 类型 描述
approvalId int64 审批ID
approvalCode string 审批编码
approvalName string 审批名称
signFlowId int64 关联的合同流程ID
signFlowName string 合同名称
approvalType int32 审批类型
approvalStatus int32 审批状态
sealId int64 关联的印章ID (用章审批时)
initiatorName string 发起人名称
createTime date-time 审批创建时间
updateTime date-time 最后更新时间
+signerList array of object 关联流程的签署人列表 (结构见 签署人信息)
... ... 其他字段见JSON

流程处理结果响应 (`SignFlowProcessRes`)

执行审批、撤销审批等操作后的响应数据结构。

参数名 类型 描述
flowId int64 关联的流程ID
flowStatus int32 操作后流程的状态
flowDesc string 流程描述
flowTitle string 流程标题

批量流程处理结果响应 (`SignFlowProcessBatchRes`)

批量审批后的响应数据结构。

参数名 类型 描述
failedCount int32 失败数量
successCount int32 成功数量
+signFlowProcessResps array of object 每个操作的结果列表 (结构见 SignFlowProcessRes)