跳到主要内容

撤销单个签署流程

1. 接口描述​

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

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

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CancelFlow。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
Operator是UserInfo调用方用户信息，userId 必填
FlowId是String签署流程id
CancelMessage是String撤销原因，最长200个字符；
Agent否Agent代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

3. 输出参数​

参数名称类型描述
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 撤销签署流程样例​

撤销单个签署流程

输入示例​

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

{
    "Operator": {
        "UserId": "yDxMkUy***************JmKxPkk"
    },
    "FlowId": "yDR1HUU***************JjE8imAxVxl3",
    "CancelMessage": "字符串"
}

输出示例​

{
    "Response": {
        "RequestId": "85b29b***************651ecc8"
    }
}

5. 开发者资源​

腾讯云 API 平台​

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

API Inspector​

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

SDK​

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

命令行工具​

6. 错误码​

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

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