tencent cloud

APIs

文档APIsCaptchaConsole v2.0 APIsDescribeCaptchaInfoListInternational

查询验证码列表国际

下载
聚焦模式
字号
最后更新时间: 2026-09-08 19:37:56

1. 接口描述

接口请求域名: captcha.intl.tencentcloudapi.com 。

查询验证码列表信息,获取所有验证的CaptchaAppId、验证名称等信息国际。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCaptchaInfoListInternational。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,此参数为可选参数。
PageIndex Integer

分页参数-页号

PageSize Integer

分页参数-每页数据量

UserSetCapTypeArr.N Array of String

查询参数-行为验证类型

枚举值:

  • 1: 无感验证
  • 2: 滑动拼图
  • 8: 图形点选
  • 9: 语音验证
VerifyRankArr.N Array of String

查询参数-风控等级

枚举值:

  • 1: 体验优先
  • 2: 平衡
  • 3: 安全优先
ChannelInfoArr.N Array of String

查询参数-客户端多选

枚举值:

  • web: web类型
  • ios: ios类型
  • android: android类型
CaptchaAppId String

查询参数-验证Id

AppName String

查询参数-验证名称

OrderBy OrderByInternational

排序参数

入参限制:desc:根据创建时间排倒叙; asc:根据创建时间排升序

3. 输出参数

参数名称 类型 描述
Data DescribeCaptchaConsoleDataInternational

分页查询后数据块

CaptchaCode Integer

验证码返回码

CaptchaMsg String

验证码返回信息

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

4. 示例

示例1 请求和返回示例

查询验证码列表信息

输入示例

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

{
    "CaptchaAppId": "179*****2",
    "OrderBy": {
        "CreateTime": "字符串"
    },
    "PageIndex": "整型",
    "UserSetCapTypeArr": [
        "字符串"
    ],
    "ChannelInfoArr": [
        "字符串"
    ],
    "PageSize": "整型",
    "AppName": "字符串",
    "VerifyRankArr": [
        "字符串"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "5b320902-54f3-4b70-8663-6e86e99dffff",
        "Data": {
            "DataList": [],
            "Total": 0,
            "PageIndex": 0
        },
        "CaptchaCode": 0,
        "CaptchaMsg": "success"
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 请求未CAM授权
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation.ErrAuth 鉴权失败。
UnauthorizedOperation.Unauthorized 未开通权限/无有效套餐包/账号已欠费。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈