1. 接口描述
接口请求域名： captcha.tencentcloudapi.com 。
安全验证码用户操作票据数据查询
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCaptchaTicketData。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-22。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CaptchaAppId | 是 | Integer | 验证码应用ID 示例值：123456 |
| Start | 是 | Integer | 查询开始时间 例如：20200909 示例值：20200909 |
| End | 否 | Integer | 查询结束时间 例如：20220314 示例值：20220313 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CaptchaCode | Integer | 成功返回 0 其它失败 示例值：0 |
| CaptchaMsg | String | 返回信息 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| Data | CaptchaTicketDataRes | 验证码票据信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：{ "DateKey":"20200909", |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求和返回示例
输入示例
https://captcha.tencentcloudapi.com/?Action=DescribeCaptchaTicketData
&CaptchaAppId=201111111
&Start=20200909
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "0dab64b7-d526-4a5f-bed6-4c59b53b6d11",
"CaptchaCode": 0,
"CaptchaMsg": "",
"Data": {
"TicketAmountArray": [
{
"DateKey": "20200909",
"Amount": 94
},
{
"DateKey": "20200910",
"Amount": 7
}
],
"TicketThroughArray": [
{
"DateKey": "20200909",
"Through": 94
},
{
"DateKey": "20200910",
"Through": 7
}
],
"TicketInterceptArray": [
{
"DateKey": "20200909",
"Intercept": 0
},
{
"DateKey": "20200910",
"Intercept": 0
}
]
}
}
}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 | 未开通权限/无有效套餐包/账号已欠费。 |