跳到主要内容

根据签署流程id批量撤销合同

1. 接口描述

接口请求域名: essbasic.tencentcloudapi.com 。

指定需要批量撤销的签署流程Id,批量撤销合同 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;

可以撤回:未全部签署完成 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。

满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。

合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 具体可参考回调消息

注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelBatchCancelFlows。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
FlowIds.NArray of String签署流程Id数组,最多100个,超过100不处理
CancelMessageString撤销理由,不超过200个字符
CancelMessageFormatInteger撤销理由自定义格式;选项:

- 0 默认格式
- 1 只保留身份信息:展示为【发起方】
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】

3. 输出参数

参数名称类型描述
FailMessagesArray of String签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为“”,失败则对应失败消息
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据签署流程id批量撤销合同

指定需要批量撤销的签署流程Id,批量撤销合同 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;接口失败后返回错误信息

输入示例

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelBatchCancelFlows
<公共请求参数>

{
"FlowIds": [
"yDwhGUUfe5g******CX8ZwTiSg8gISocy"
],
"Agent": {
"ProxyOperator": {
"OpenId": "yDR3L****eTdCt5TVx"
},
"AppId": "125***319",
"ProxyOrganizationOpenId": "1000***8062"
},
"CancelMessage": "因为合同里边的金额填写错误",
"CancelMessageFormat": "0"
}

输出示例

{
"Response": {
"FailMessages": [],
"RequestId": "c5e01d20-xxxxxx09d3d32b00"
}
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码描述
FailedOperation操作失败。
InvalidParameter.DupTask重复提交任务。
InvalidParameter.ParamError参数错误。
OperationDenied操作被拒绝。
OperationDenied.FlowHasTerminated流程已终止。
OperationDenied.UserNotInOrganization用户不归属于当前企业,无法操作,请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.User用户信息不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。