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

1. 接口描述

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

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

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

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

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelBatchCancelFlows。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
FlowIds.N	是	Array of String	签署流程Id数组，最多100个，超过100不处理
CancelMessage	否	String	撤销理由,不超过200个字符
CancelMessageFormat	否	Integer	撤销理由自定义格式；选项： - 0 默认格式 - 1 只保留身份信息：展示为【发起方】 - 2 保留身份信息+企业名称：展示为【发起方xxx公司】 - 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】

3. 输出参数

参数名称	类型	描述
FailMessages	Array of String	签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为“”,失败则对应失败消息
RequestId	String	唯一请求 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	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

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

输入示例​

输出示例​

5. 错误码​