跳到主要内容

批量撤销签署流程

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateBatchCancelFlowUrl。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。

注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
FlowIds.NArray of String需要执行撤回的流程(合同)的编号列表,最多100个.

列表中的流程(合同)编号不要重复.
AgentAgent代理企业和员工的信息。

在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称类型描述
BatchCancelFlowUrlString批量撤回签署流程链接
FailMessagesArray of String签署流程撤回失败信息
数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
UrlExpireOnString签署连接过期时间字符串:年月日-时分秒

例如:2023-07-28 17:25:59
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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"
}
}

示例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": "",
"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"
}
}

5. 错误码

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

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