撤销单个合同流程

1. 接口描述

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

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

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

注:

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

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

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

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

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

推荐使用 API Explorer

点击调试

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

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. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

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. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.System	系统错误，请稍后重试。
InvalidParameter.CancelReason	不合法的撤销取消理由，将检查长度，内容，并在修改后重试。
InvalidParameter.ParamError	参数错误。
InvalidParameter.Status	参数Status不正确。
MissingParameter.CancelReason	缺少撤销取消理由，请检查修改后重试。
OperationDenied	操作被拒绝。
OperationDenied.FlowHasTerminated	签署流程已经被终止，请检查。
OperationDenied.Forbid	禁止此项操作。
OperationDenied.NoIdentityVerify	未通过个人实名认证。
OperationDenied.WhiteListForbid	未开通功能白名单，请联系客服处理。
ResourceNotFound.Flow	签署流程未找到，请检查参数。
ResourceNotFound.NotExistFlow	流程不存在。
ResourceUnavailable	资源不可用。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。