根据签署流程id创建批量撤销url
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows 客户指定需要撤销的签署流程Id,最多100个,超过100不处理; 接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
可以撤回:未全部签署完成 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateBatchCancelFlowUrl。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 |
FlowIds.N | 是 | Array of String | 签署流程Id数组 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BatchCancelFlowUrl | String | 批量撤销url |
FailMessages | Array of String | 签署流程批量撤销失败原因 |
UrlExpireOn | String | 签署撤销url过期时间-年月日-时分秒 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据签署流程id创建批量撤回url
指定需要批量撤回的签署流程Id,获取批量撤销链接 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateBatchCancelFlowUrl
<公共请求参数>
{
"Agent": {
"ProxyOrganizationOpenId": "600***487",
"ProxyOperator": {
"OpenId": "7f3497f0****7b0ec"
},
"AppId": "130****4283"
},
"FlowIds": [
"yDwF*****Xhgx9shH"
]
}
输出示例
{
"Response": {
"BatchCancelFlowUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=BATCH_REVOKE_FLOW&tokenId=yDwhCUUck*****dKO5TA&userId=yDxHTUUgydj9*****yrY850RBN&expireOn=1690030266&login=1&verify=1",
"FailMessages": [
""
],
"RequestId": "e906c2a4-cb12-4f33-891e-39352d4dee3d",
"UrlExpireOn": "2023-07-22 20:51:06"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |