接口请求域名： captcha.intl.tencentcloudapi.com 。
核查验证码票据结果(Web及APP)
默认接口请求频率限制：1000次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCaptchaResult。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-22。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| CaptchaType | 是 | Integer | 固定填值：9。 |
| Ticket | 是 | String | 前端回调函数返回的用户验证票据 |
| UserIp | 是 | String | 业务侧获取到的验证码使用者的外网IP |
| Randstr | 是 | String | 前端回调函数返回的随机字符串 |
| CaptchaAppId | 是 | Integer | 验证码应用ID。登录 验证码控制台，在验证列表的【密钥】列，即可查看到CaptchaAppId。 |
| AppSecretKey | 是 | String | 验证码应用密钥。登录 验证码控制台，在验证列表的【密钥】列，即可查看到AppSecretKey。AppSecretKey属于服务器端校验验证码票据的密钥，请妥善保密，请勿泄露给第三方。 |
| BusinessId | 否 | Integer | 预留字段 |
| SceneId | 否 | Integer | 预留字段 |
| MacAddress | 否 | String | mac 地址或设备唯一标识 |
| Imei | 否 | String | 手机设备号 |
| NeedGetCaptchaTime | 否 | Integer | 是否返回前端获取验证码时间，取值1：需要返回 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CaptchaCode | Integer | 1 OK 验证通过 7 captcha no match 传入的Randstr不合法，请检查Randstr是否与前端返回的Randstr一致 8 ticket expired 传入的Ticket已过期（Ticket有效期5分钟），请重新生成Ticket、Randstr进行校验 9 ticket reused 传入的Ticket被重复使用，请重新生成Ticket、Randstr进行校验 15 decrypt fail 传入的Ticket不合法，请检查Ticket是否与前端返回的Ticket一致 16 appid-ticket mismatch 传入的CaptchaAppId错误，请检查CaptchaAppId是否与前端传入的CaptchaAppId一致，并且保障CaptchaAppId是从验证码控制台【验证管理】->【基础配置】中获取 21 diff 票据校验异常，可能的原因是（1）若Ticket包含trerror前缀，一般是由于用户网络较差，导致前端自动容灾，而生成了容灾票据，业务侧可根据需要进行跳过或二次处理。（2）若Ticket不包含trerror前缀，则是由于验证码风控系统发现请求有安全风险，业务侧可根据需要进行拦截。 100 appid-secretkey-ticket mismatch 参数校验错误，（1）请检查CaptchaAppId与AppSecretKey是否正确，CaptchaAppId、AppSecretKey需要在验证码控制台【验证管理】>【基础配置】中获取（2）请检查传入的Ticket是否由传入的CaptchaAppId生成 |
| CaptchaMsg | String | 状态描述及验证错误信息 |
| EvilLevel | Integer | 无感验证模式下，该参数返回验证结果： EvilLevel=0 请求无恶意 EvilLevel=100 请求有恶意 |
| GetCaptchaTime | Integer | 前端获取验证码时间，时间戳格式 |
| EvilBitmap | Integer | 拦截类型 注意：此字段可能返回 null，表示取不到有效值。 |
| SubmitCaptchaTime | Integer | 提交验证码时间 |
| DeviceRiskCategory | String | 设备风险大类 注意：此字段可能返回 null，表示取不到有效值。 |
| Score | Integer | 验证码评分 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
票据校验
POST / HTTP/1.1
Host: captcha.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCaptchaResult
<公共请求参数>
{
"CaptchaAppId": 199999164,
"CaptchaType": 9,
"NeedGetCaptchaTime": 1,
"Randstr": "@Vki",
"UserIp": "127.0.0.1",
"Ticket": "tr03XaCUZPAlPdIMqv17yvcfdXCzkqvLE09AbCA4ghlWfD8hkySfbU2TZVCyoOCjNI84pAYEMopKv7Uh8XwQDSE9DC0xJpXVC7kmlPENlbFINs_N937qkoEmU6Pl8e-9EkFQzvrrwsZOTKQ*",
"AppSecretKey": "E4kwK9AcXQMHkktiItyMEyQPn"
}
{
"Response": {
"CaptchaCode": 0,
"CaptchaMsg": "not valid",
"EvilLevel": 0,
"GetCaptchaTime": 1729583235,
"SubmitCaptchaTime": 1729583239,
"EvilBitmap": 0,
"RequestId": "7c370964-7deb-4008-8b29-47e87e60c1e0"
},
"retcode": 0,
"retmsg": "success"
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation.ErrAuth | 鉴权失败。 |
| UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback