文档变更
2022年时，签署流程撤销变为撤销签署流程，以便开发者更容易理解，仅中文名称变更，其功能保持不变。
接口描述
撤销签署流程，撤销后流程中止，所有签署无效。
接口地址&请求方式
接口地址：/v1/signflows/{flowId}/revoke
请求方式：PUT
请求头格式
具体请求头格式结构，请点击查看公共参数说明。
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 |
flowId | string | 是 | path | 签署流程ID |
operatorId | string | 否 | body | 发起人账户id，即发起本次签署的操作人个人账号id； 如不传，默认由对接平台发起。 |
revokeReason | string | 否 | body | 撤销原因,默认"撤销"（最长400字节） 补充说明：
|
响应参数
参数名称 | 类型 | 必选 | 参数说明 |
code | int | 是 | 业务码，0表示成功 |
message | string | 否 | 业务信息 |
data | object | 否 | 业务数据 |
请求示例
PUT https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/revoke{
"operatorId":"40eb61714d9e49088bac7a3c56d69d66",
"revokeReason":"合同撤销：合同内容有误"
}响应示例
{
"code":0,
"message":"成功",
"data":null
}错误码
错误码 | 错误描述 | 排查方法 |
1437111 | 非开启状态不允许撤回流程 | 只能撤销状态为签署中的流程 |
1437168 | 流程已撤销 | 重复调用撤销接口导致 |
1437148 | 当前用户不是流程发起人， 不能撤回流程 | 请传入正确的发起人账号id |
1438108 | 更新合同管理流程状态异常 | 撤销原因revokeReason控制在400个字节以内 |
我要纠错