撤销单个合同流程

1. 接口描述

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

用于撤销合同流程

适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。

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

注:

1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口。

2. 有对应合同撤销权限的人: 合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人
   

3. 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。

4. 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CancelFlow。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
FlowId	是	String	合同流程ID, 为32位字符串。 可登录腾讯电子签控制台，点击查看FlowId在控制台中的位置 示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
CancelMessage	是	String	撤销此合同流程的撤销理由，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。 示例值：这个合同里边的付款金额写错
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

4. 示例

示例1 撤销签署流程样例

撤销单个签署流程

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "FlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "CancelMessage": "这个合同里边的付款金额写错了"
}

输出示例

{
    "Response": {
        "RequestId": "85651ecc8"
    }
}

示例2 错误示例-撤销一个已经签署完成的流程合同

1. 合同已经签署完成
2. 撤销该合同

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "FlowId": "yDwFkUUckpstzjhfUugNAWf1KibXqS26",
    "CancelMessage": "这个合同里边的付款金额写错了"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "OperationDenied.FlowHasTerminated",
            "Message": "此流程已经终止，当前所有参与者签署"
        },
        "RequestId": "s1693***537224"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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