验证码
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 验证码 > API 文档 > 控制台v1.0相关接口 > 安全验证码小程序插件查询请求数据概况

安全验证码小程序插件查询请求数据概况

最近更新时间：2024-03-12 01:12:21

我的收藏

本页目录：

1. 接口描述

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

安全验证码小程序插件查询请求数据概况

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeCaptchaMiniDataSum。
Version 是 String 公共参数，本接口取值：2019-07-22。
Region 否 String 公共参数，本接口不需要传递此参数。
CaptchaAppId 是 Integer 验证码应用ID
Start 是 Integer 查询开始时间
End 是 Integer 查询结束时间

3. 输出参数

参数名称 类型 描述
GetSum Integer 请求总量
注意：此字段可能返回 null，表示取不到有效值。
VfySuccSum Integer 请求验证成功量
注意：此字段可能返回 null，表示取不到有效值。
VfySum Integer 请求验证量
注意：此字段可能返回 null，表示取不到有效值。
AttackSum Integer 拦截攻击量
注意：此字段可能返回 null，表示取不到有效值。
CaptchaMsg String 返回信息
注意：此字段可能返回 null，表示取不到有效值。
CaptchaCode Integer 成功返回0 其它失败
注意：此字段可能返回 null，表示取不到有效值。
CheckTicketSum Integer 票据校验总量
注意：此字段可能返回 null，表示取不到有效值。
TicketThroughputSum Integer 票据验证通过量
注意：此字段可能返回 null，表示取不到有效值。
TicketInterceptSum Integer 票据验证拦截量
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求和返回示例

输入示例

https://captcha.tencentcloudapi.com/?Action=DescribeCaptchaMiniDataSum
&CaptchaAppId=2010000000
&Start=20191201
&End=20191201
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "c7151640-8351-46d5-86f9-ce886cf37111",
        "CaptchaCode": 0,
        "CaptchaMsg": "OK",
        "GetSum": 123,
        "VfySuccSum": 112,
        "VfySum": 110,
        "AttackSum": 13,
        "CheckTicketSum": 100,
        "TicketThroughputSum": 90,
        "TicketInterceptSum": 10
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation.ErrAuth 鉴权失败。
UnauthorizedOperation.Unauthorized 未开通权限/无有效套餐包/账号已欠费。
中国站