跳到主要内容

批量撤销签署流程

1. 接口描述​

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

注：此接口将会废弃，请使用撤销单个签署流程（CancelFlow）接口。 指定需要批量撤回的签署流程Id，获取批量撤销链接。 客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateBatchCancelFlowUrl。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
Operator是UserInfo调用方用户信息，userId 必填
FlowIds.N是Array of String需要执行撤回的签署流程id数组，最多100个

3. 输出参数​

参数名称类型描述
BatchCancelFlowUrlString批量撤回签署流程链接
FailMessagesArray of String签署流程撤回失败信息
UrlExpireOnString签署连接过期时间字符串：年月日-时分秒
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 获取批量撤销签署流程链接​

电子签企业版：指定需要批量撤回的签署流程Id，获取批量撤销链接 客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回

输入示例​

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

{
    "Operator": {
        "UserId": "1956103********520fde6a"
    },
    "FlowIds": [
        "1",
        "2"
    ]
}

输出示例​

{
    "Response": {
        "BatchCancelFlowUrl": "url",
        "FailMessages": [
            "",
            ""
        ],
        "UrlExpireOn": "",
        "RequestId": "test"
    }
}

5. 开发者资源​

腾讯云 API 平台​

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

API Inspector​

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

SDK​

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

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError.System系统错误，请稍后重试。
MissingParameter.FlowId缺少签署流程id，请检查修改后重试。
OperationDenied.BatchCancelForbid不允许批量撤销签署流程，请检查批量撤销合同信息。
ResourceNotFound.ErrNotExistRole未获取到用户角色信息，请检查员工角色配置。
ResourceNotFound.Flow签署流程未找到，请检查参数。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。