签署任务控制 API

对进行中的签署任务进行管理和干预操作。

签署任务控制

本部分包含用于控制签署流程状态和进行管理操作的API接口。

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

撤销尚未完成的签署任务。只有流程发起方可以执行此操作。

请求 Header (通用认证参数)

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

请求参数 (Body)

参数名 类型 必填 描述
flowId integer (int64) 是 需要撤销的流程ID
cancelMsg string 否 撤销原因

请求示例

CURL
curl -X POST 'https://your-api-host.com/signTask/contract/cancel' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: INITIATOR_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 12001,
  "cancelMsg": "信息填写有误，重新发起"
}'

响应参数

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

响应示例

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

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误 (如flowId无效)
401 未授权
403 禁止访问 (非发起人或流程已结束/已撤销)
404 流程不存在
500 服务器内部错误
POST /signTask/contract/del 删除合同

删除签署任务记录。通常只能删除处于草稿、已撤销、已拒签等非进行中或非完成状态的流程。

请求 Header (通用认证参数)

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

请求参数 (Body)

参数名 类型 必填 描述
flowId integer (int64) 是 需要删除的流程ID

请求示例

CURL
curl -X POST 'https://your-api-host.com/signTask/contract/del' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 12005
}'

响应参数

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

响应示例

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

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误
401 未授权
403 禁止访问 (无权限删除或流程状态不允许删除)
404 流程不存在
500 服务器内部错误
POST /signTask/contract/modify 修改合同备注

修改指定签署流程的备注信息。

请求 Header (通用认证参数)

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

请求参数 (Body)

参数名 类型 必填 描述
flowId integer (int64) 是 需要修改备注的流程ID
remark string 是 新的备注内容

请求示例

CURL
curl -X POST 'https://your-api-host.com/signTask/contract/modify' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 12001,
  "remark": "补充说明：已与乙方电话确认细节。"
}'

响应参数

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

响应示例

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

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误 (如备注过长)
401 未授权
403 禁止访问 (无权修改该流程备注)
404 流程不存在
500 服务器内部错误
POST /signTask/signFlowRemind 流程催办

向当前待处理的参与方发送催办提醒通知（通常是短信或应用内消息）。

请求 Header (通用认证参数)

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

请求参数 (Body)

参数名 类型 必填 描述
flowId integer (int64) 是 需要催办的流程ID

请求示例

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

响应参数

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

响应示例

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

错误码

HTTP状态码/业务码 描述
200 成功
400 请求参数错误
401 未授权
403 禁止访问 (无权催办或流程非签署中状态)
404 流程不存在
XXX 业务错误 (如催办过于频繁)
500 服务器内部错误 (如发送通知失败)

共享数据模型参考

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

撤销合同参数 (`签署流程修改保密属性请求参数`)

参数名 类型 描述
flowId int64 流程ID
cancelMsg string 撤销原因

删除合同参数 (`签署合同流程删除请求参数`)

参数名 类型 描述
flowId int64 流程ID

修改备注参数 (`修改签署流程备注请求参数`)

参数名 类型 描述
flowId int64 流程ID
remark string 新的备注内容

流程ID参数 (`流程id参数`)

参数名 类型 描述
flowId int64 流程ID