核查验证码票据结果

最近更新时间:2019-08-09 17:01:50

1. 接口描述

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

核查验证码票据结果

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCaptchaResult
Version String 公共参数,本接口取值:2019-07-22
Region String 公共参数,本接口不需要传递此参数。
CaptchaType Integer 验证码类型,9:滑块验证码
Ticket String 验证码返回给用户的票据
UserIp String 用户操作来源的外网 IP
Randstr String 验证票据需要的随机字符串
CaptchaAppId Integer 验证码应用ID
AppSecretKey String 用于服务器端校验验证码票据的验证密钥,请妥善保密,请勿泄露给第三方
BusinessId Integer 业务 ID,网站或应用在多个业务中使用此服务,通过此 ID 区分统计数据
SceneId Integer 场景 ID,网站或应用的业务下有多个场景使用此服务,通过此 ID 区分统计数据
MacAddress String mac 地址或设备唯一标识
Imei String 手机设备号

3. 输出参数

参数名称 类型 描述
CaptchaCode Integer 1:验证成功,0:验证失败,100:AppSecretKey参数校验错误
CaptchaMsg String 状态描述及验证错误信息
注意:此字段可能返回 null,表示取不到有效值。
EvilLevel Integer [0,100],恶意等级
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求和返回示例

输入示例

https://captcha.tencentcloudapi.com/?Action=DescribeCaptchaResult
&CaptchaType=9&Ticket=xxxx
&UserIp=127.0.0.1
&Randstr=xxx
&CaptchaAppId=201111111
&AppSecretKey=xxxxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "3b61a17b-cb38-470e-802c-b6242faf81ac",
    "CaptchaCode": 1,
    "CaptchaMsg": "OK",
    "EvilLevel": 0
  },
  "retcode": 0,
  "retmsg": "success"
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation.ErrAuth 鉴权失败。
UnauthorizedOperation.Unauthorized 未开通权限。