跳到主要内容

取消一码多扫二维码

1. 接口描述​

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

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

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCancelMultiFlowSignQRCode。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
QrCodeId是String需要取消签署的二维码ID，为32位字符串。由创建一码多扫流程签署二维码返回

3. 输出参数​

参数名称类型描述
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 取消一码多扫流程签署二维码​

取消一码多扫流程签署二维码

输入示例​

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

{
    "QrCodeId": "yDSLZUUckpooi1ltUxCsD3RSTG9BEWhR",
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    }
}

输出示例​

{
    "Response": {
        "RequestId": "dfc69a6f-7738-45f3-a238-99e0e89bc91a"
    }
}

示例2 取消一码多扫流程签署二维码-已失效​

废除一码多扫流程签署二维码，若二维码已经失效，则返回操作失败。

输入示例​

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

{
    "QrCodeId": "yDSLZUUckpooi1ltUxCsD3RSTG9BEWhR",
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    }
}

输出示例​

{
    "Response": {
        "Error": {
            "Code": "OperationDenied.QrInvalid",
            "Message": "签署二维码不可用，请检查后重试。"
        },
        "RequestId": "dfc69a6f-7738-45f3-a238-99e0e89bc91a"
    }
}

5. 错误码​

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

错误码描述
InternalError内部错误。
InternalError.DbRead数据库读取失败。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied.Forbid禁止操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。