腾讯电子签获取批量撤销签署流程腾讯电子签小程序链接

1. 接口描述

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

指定需要批量撤回的签署流程Id，以获取批量撤销链接。
客户需指定要撤回的签署流程Id，最多可指定100个，超过100则不处理。
接口调用成功后，将返回批量撤回合同的链接。通过点击链接，可跳转至电子签小程序完成批量撤回操作。

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

批量撤销结果可以通过接口返回的TaskId关联批量撤销任务结果回调或通过接口查询批量撤销签署流程任务结果

注：

如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口。
有对应合同撤销权限的人: 合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人
只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。
撤销后可以看合同PDF内容的人员：发起方的超管，发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员，其他参与人员看不到合同的内容。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateBatchCancelFlowUrl。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
FlowIds.N	是	Array of String	需要执行撤回的流程(合同)的编号列表，最多100个. 列表中的流程(合同)编号不要重复. 示例值：["yDt1JUUckp77a2omUyEmko88eg49PTsN"]
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
BatchCancelFlowUrl	String	批量撤回签署流程链接示例值：https://qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu
FailMessages	Array of String	签署流程撤回失败信息数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错示例值：["合同已经过期"]
UrlExpireOn	String	签署连接过期时间字符串：年月日-时分秒示例值：2023-07-28 17:25:59
TaskId	String	批量撤销任务编号，为32位字符串，可用于查询批量撤销签署流程任务结果或关联批量撤销任务结果回调示例值：yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

指定需要批量撤回三个签署流程Id，获取批量撤销链接
接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回

输入示例

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

{
    "Operator": {
        "UserId": "1956103********520fde6a"
    },
    "FlowIds": [
        "yDwhIUUck********Ekio7sxsMq",
        "yDwhIUUckp*******UuaXC88Rgc",
        "yDwhIUUckp*******7sySp2O5D38"
    ]
}

输出示例

{
    "Response": {
        "BatchCancelFlowUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=BATCH_REVOKE_FLOW&tokenId=yDwhIUU*****BtD1PuoS7&userId=yD******4zjEwqXwsIljA&expireOn=1690536359&login=1&verify=1",
        "FailMessages": [
            "",
            "",
            ""
        ],
        "RequestId": "s1690449958963022285",
        "UrlExpireOn": "2023-07-28 17:25:59",
        "TaskId": "yDCVWUUckpwk3b05UyEZnO0xOn4snWWY"
    }
}

示例2 获取批量撤销签署流程链接失败

获取批量撤销签署流程链接失败

输入示例

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

{
    "Operator": {
        "UserId": "1956103********520fde6a"
    },
    "FlowIds": [
        "yDwhIUUck********Ekio7sxsMq",
        "yDwhIUUckp*******UuaXC88Rgc",
        "yDwhIUUckp*******7sySp2O5D39"
    ]
}

输出示例

{
    "Response": {
        "BatchCancelFlowUrl": "",
        "FailMessages": [
            "合同流程Id:xxx,无法撤回，错误信息：非本企业发起的合同",
            "合同流程Id:xxx,无法撤回，错误信息：非本企业发起的合同",
            "合同流程Id:xxx,无法撤回，错误信息：非本企业发起的合同"
        ],
        "UrlExpireOn": "",
        "TaskId": "",
        "RequestId": "s1690449958963022285"
    }
}

示例3 获取批量撤销签署流程链接部分成功

获取批量撤销签署流程链接部分成功

输入示例

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

{
    "Operator": {
        "UserId": "1956103********520fde6a"
    },
    "FlowIds": [
        "yDwhIUUck********Ekio7sxsMq",
        "yDwhIUUckp*******UuaXC88Rgc",
        "yDwhIUUckp*******7sySp2O5D38"
    ]
}

输出示例

{
    "Response": {
        "BatchCancelFlowUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=BATCH_REVOKE_FLOW&tokenId=yDwhIUU*****BtD1PuoS7&userId=yD******4zjEwqXwsIljA&expireOn=1690536359&login=1&verify=1",
        "FailMessages": [
            "合同流程Id:xxx,无法撤回，错误信息：非本企业发起的合同",
            "",
            ""
        ],
        "RequestId": "s1690449958963022285",
        "UrlExpireOn": "2023-07-28 17:25:59",
        "TaskId": "yDCVWUUckpwk4b05UyEZnO0xOn3snWWY"
    }
}

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

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

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

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

私有网络

云函数

API 网关

专线接入

批量计算

对象存储

微服务平台 TSF

文件存储

消息队列 CKafka 版

全站加速网络

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

数据传输服务

全球应用加速

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

标签

DDoS 防护

密钥管理系统

Web 应用防火墙

操作审计

域名注册

SSL 证书

短信

数据万象

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

人脸识别

流计算 Oceanus

腾讯云数据仓库 TCHouse-P

Elasticsearch Service

集团账号管理

图像识别

文字识别

口语评测（基础版）

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

弹性 MapReduce

游戏数据库 TcaplusDB

腾讯云 BI

游戏多媒体引擎

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

腾讯云数据仓库 TCHouse-D

数据加速器 GooseFS

知识引擎原子能力

统一 Catalog 服务

声音复刻

文旅客情大数据

实时互动-工业能源版

腾讯健康组学平台

大模型图像创作引擎

云压测

腾讯云微搭低代码