1. 接口描述
接口请求域名： captcha.tencentcloudapi.com 。
查询安全验证码应用APPId信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCaptchaAppIdInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-22。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CaptchaAppId | 是 | Integer | 验证码应用注册APPID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SchemeColor | String | 界面风格 |
| Language | Integer | 语言 |
| SceneType | Integer | 场景 |
| EvilInterceptGrade | Integer | 防控风险等级 |
| SmartVerify | Integer | 智能验证 |
| SmartEngine | Integer | 智能引擎 |
| CapType | Integer | 验证码类型 |
| AppName | String | 应用名称 |
| DomainLimit | String | 域名限制 |
| MailAlarm | Array of String | 邮件告警 注意：此字段可能返回 null，表示取不到有效值。 |
| TrafficThreshold | Integer | 流量控制 |
| EncryptKey | String | 加密key |
| TopFullScreen | Integer | 是否全屏 |
| CaptchaCode | Integer | 成功返回0 其它失败 |
| CaptchaMsg | String | 返回操作信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求和返回示例
输入示例
https://captcha.tencentcloudapi.com/?Action=DescribeCaptchaAppIdInfo
&CaptchaAppId=211111111
&<公共请求参数>输出示例
{
"Response": {
"SchemeColor": "#1a79ff",
"SceneType": 1,
"EvilInterceptGrade": 0,
"SmartVerify": 0,
"SmartEngine": 1,
"CapType": 13,
"AppName": "小程序短信验证",
"DomainLimit": "",
"TrafficThreshold": 0,
"TopFullScreen": 0,
"RequestId": "956f01e4-86e3-4b12-a1cd-1f668f71a121",
"CaptchaCode": 0,
"CaptchaMsg": "",
"Language": 2052,
"MailAlarm": null,
"EncryptKey": "*******"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation.ErrAuth | 鉴权失败。 |
| UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |
