1. 接口描述
接口请求域名： captcha.tencentcloudapi.com 。
核查验证码票据结果(小程序插件)
默认接口请求频率限制：1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCaptchaMiniResult。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-22。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CaptchaType | 是 | Integer | 固定填值：9 示例值：9 |
| Ticket | 是 | String | 验证码返回给用户的票据 示例值：tr03XaCUZPAlPdIMqv17yvcfdXCzkqvLE09AbCA4ghlWfD8hkySfbU2TZVCyoOCjNI84pAYEMopKv7Uh8XwQDSE9DC0xJpXVC7kmlPENlbFINs_N937qkoEmU6Pl8e-9EkFQzvrrwsZOTKQ* |
| UserIp | 是 | String | 业务侧获取到的验证码使用者的外网IP 示例值：127.0.0.1 |
| CaptchaAppId | 是 | Integer | 验证码应用ID。登录 验证码控制台，在验证列表的【密钥】列，即可查看到CaptchaAppId。 示例值：199999164 |
| AppSecretKey | 是 | String | 验证码应用密钥。登录 验证码控制台，在验证列表的【密钥】列，即可查看到AppSecretKey。AppSecretKey属于服务器端校验验证码票据的密钥，请妥善保密，请勿泄露给第三方。 示例值：E4kwK9AcXQMHkktRItyMEyQnp |
| BusinessId | 否 | Integer | 业务 ID，网站或应用在多个业务中使用此服务，通过此 ID 区分统计数据 示例值：1 |
| SceneId | 否 | Integer | 场景 ID，网站或应用的业务下有多个场景使用此服务，通过此 ID 区分统计数据 示例值：3 |
| MacAddress | 否 | String | mac 地址或设备唯一标识 示例值："00:1A:2B:3C:4D:5E" |
| Imei | 否 | String | 手机设备号 示例值："359880051234567" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CaptchaCode | Integer | 1 ticket verification succeeded 票据验证成功 7 CaptchaAppId does not match 票据与验证码应用APPID不匹配 8 ticket expired 票据超时 10 ticket format error 票据格式不正确 15 ticket decryption failed 票据解密失败 16 CaptchaAppId wrong format 检查验证码应用APPID错误 21 (1)ticket error 票据验证错误 (2)diff 一般是由于用户网络较差，导致前端自动容灾，而生成了容灾票据，业务侧可根据需要进行跳过或二次处理 25 invalid ticket 无效票据 26 system internal error 系统内部错误 31 UnauthorizedOperation.Unauthorized 无有效套餐包/账户已欠费 100 param err 参数校验错误 示例值：8 |
| CaptchaMsg | String | 状态描述及验证错误信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：ticket expired |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求和返回示例
输入示例
POST / HTTP/1.1
Host: captcha.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCaptchaMiniResult
<公共请求参数>
{
"UserIp": "127.0.0.1",
"CaptchaAppId": "199999164",
"Ticket": "tr03z8JQftDQ5ZMteDlvkg6GbucZQTiG8dq53boJY8xJoq6PanrsicK9NOQcK6G2aXSjReWIxVvXt1Y6TXnaWvBy3k2hp_gRSwpi_ZEu3j8BUY2vuuyg-c1tZc3c8GfLdVlqJbOQ5JdAFos*",
"AppSecretKey": "E4kwK9AcXQMHkktiItyMEyQPn",
"CaptchaType": "9"
}输出示例
{
"Response": {
"RequestId": "a0b3a098-b8f6-4001-764b-47f3843249db",
"CaptchaCode": 8,
"CaptchaMsg": "ticket expired"
}
}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 | 未开通权限/无有效套餐包/账号已欠费。 |
