跳到主要内容

取消一码多签签署码

1. 接口描述

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

此接口(CancelMultiFlowSignQRCode)用于废除一码多签签署码。 该接口所需的二维码ID,源自创建一码多签签署码生成的。 如果该签署码尚处于有效期内,可通过本接口将其设置为失效状态。

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CancelMultiFlowSignQRCode。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
QrCodeIdString需要取消的签署码ID,为32位字符串。由创建一码多签签署码返回
示例值:yDR***Apl
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称类型描述
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 取消一码多签签署码

取消一码多签签署码

输入示例

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

{
"Operator": {
"UserId": "yDxxxxxxx"
},
"QrCodeId": "yDRvQxxxxxKC"
}

输出示例

{
"Response": {
"RequestId": "1c75e86d-xxxxxxxxxx6f330a05e"
}
}

示例2 取消一码多签签署码-已失效

废除取消一码多签签署码,若签署码已经失效,则返回操作失败。

输入示例

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

{
"Operator": {
"UserId": "yDxxxxxxx"
},
"QrCodeId": "yDRvQxxxxxKC"
}

输出示例

{
"Response": {
"Error": {
"Code": "OperationDenied.QrInvalid",
"Message": "签署二维码不可用,请检查后重试。"
},
"RequestId": "s169*****0872"
}
}

5. 错误码

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

错误码描述
InternalError内部错误。
InternalError.System系统错误,请稍后重试。
InvalidParameter.DataNotFound数据不存在。
MissingParameter缺少参数错误。
MissingParameter.QrCodeId缺少签署二维码id,请检查后重试。
MissingParameter.UserId缺少用户id,请检查后重试。
OperationDenied操作被拒绝。
OperationDenied.QrHasExpire签署二维码已过期,请检查后重试。
OperationDenied.QrInvalid签署二维码不可用,请检查后重试。
ResourceNotFound.QrInfo签署二维码信息不存在,请检查后重试。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062