腾讯电子签集成版获取批量撤销合同流程的腾讯电子签小程序链接-API 文档-文档中心-腾讯云

1. 接口描述

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

通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同, 返回的链接需要有此权限的人合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人在手机端打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同

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

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

批量撤销结果可以通过接口返回的TaskId关联批量撤销任务结果回调或通过接口查询批量撤销合同结果主动查询。

注:

签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口
只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。
撤销后可以看合同PDF内容的人员：发起方的超管，发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员，其他参与人员看不到合同的内容。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelCreateBatchCancelFlowUrl。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名认证
FlowIds.N	是	Array of String	要撤销的合同流程ID列表，最多100个，超过100不处理

3. 输出参数

参数名称	类型	描述
BatchCancelFlowUrl	String	批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时注：生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）示例值：https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?to=BATCH_REVOKE_FLOW&tokenId=yY&userId=yG&expireOn=1699011136&login=1&verify=1
FailMessages	Array of String	与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
UrlExpireOn	String	签署撤销链接的过期时间(格式为:年-月-日时:分:秒), 默认是生成链接的24小时后失效示例值：2023-11-03 19:46:40
TaskId	String	批量撤销任务编号，为32位字符串，可用于查询批量撤销合同结果或关联批量撤销任务结果回调
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取两个合同撤销的腾讯电子签小程序链接

获取两个合同撤销的腾讯电子签小程序链接

输入示例

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_diziqain",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowIds": [
        "yDSLKUUckpoqyl0rUyC8ScPwfefxADo9",
        "yDSLKUUckpoq79wpUw8Md4qaPVed40LQ"
    ]
}

输出示例

{
    "Response": {
        "BatchCancelFlowUrl": "https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?to=BATCH_REVOKE_FLOW&tokenId=yDSLKUUc*a7KQNiW2&userId=yDwJ5UUckpk*DyBpuGTgVEGzo&expireOn=1699013729&login=1&verify=1",
        "FailMessages": [
            "",
            ""
        ],
        "UrlExpireOn": "2023-11-03 20:15:29",
        "TaskId": "yDCVWUUckpwk3b05UyEZnO0xOn3snWWY",
        "RequestId": "549a7dce-5d89-4797-85c1-d8b2794fcc73"
    }
}

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	操作失败。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

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

本页目录：