文档中心 > API类目 > 聚安全API

alibaba.security.jaq.captcha.verify (聚安全安全验证检查接口)

聚安全安全验证检查

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
captcha_type Number 必须 1 验证码发送渠道类型 1-短信 2-语音 3-邮件
extend_data String 可选 {"userInputCaptcha": "123456"} 扩展字段,格式为JSON字符串,用于传递“短信验证”等验证方式所需的额外入参,例如用户输入的验证码等,格式及JSON字段key定义请参考示例
info_token String 必须 57a5c6ce-06c6-11e6-8ba5-a0d3c1f1fdf4 风险识别接口返回的信息口令
protocol_version String 必须 1.0 协议版本号
rsign String 可选 a3a6c0de6db6c85d1ec183e95f082f08 软token签名
rtken_index String 可选 c2607d757dcad439b94349e99fc6bab8 软token索引
session_id String 必须 4387664e-effb-11e5-8ba5-a0d3c1f1fdf4c2607d757dcad439b94349e99fc6bab8 验证码会话ID
utoken String 必须 Uk/41dHvLE4DALlys7tWlJuq UMID token

响应参数

名称 类型 示例值 描述
data JaqVerifyCaptchaResult 出参结构体
  • └ extend_data
  • String
  • {"extendKey": "extendValue"}
  • 扩展字段,格式为JSON字符串,当前为预留字段
  • jaq_dispatch_param
  • JaqDispatchParam
  • 安全验证前向化下发参数结构体
  • └ event_id
  • String
  • 913235a6-efdc-11e5-8ba5-a0d3c1f1fdf4
  • 事件ID
  • └ protocol_version
  • String
  • 1.0
  • 协议版本号
  • └ rtken
  • String
  • NDI3MiZFZG81SVZJVHpYUUwrZlBKVlNPTU1nPT0
  • 下发的软token密文
  • └ rtken_index
  • String
  • aadffa525022d4d8a2ff15cac28334db
  • 下发的软token索引
  • └ verify_status
  • Number
  • 10
  • 验证检查请求是否调用成功(及状态),约定正值为成功,负值为失败

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaSecurityJaqCaptchaVerifyRequest req = new AlibabaSecurityJaqCaptchaVerifyRequest();
req.setCaptchaType(1L);
req.setExtendData("{\"userInputCaptcha\": \"123456\"}");
req.setInfoToken("57a5c6ce-06c6-11e6-8ba5-a0d3c1f1fdf4");
req.setProtocolVersion("1.0");
req.setRsign("a3a6c0de6db6c85d1ec183e95f082f08");
req.setRtkenIndex("c2607d757dcad439b94349e99fc6bab8");
req.setSessionId("4387664e-effb-11e5-8ba5-a0d3c1f1fdf4c2607d757dcad439b94349e99fc6bab8");
req.setUtoken("Uk/41dHvLE4DALlys7tWlJuq");
AlibabaSecurityJaqCaptchaVerifyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_security_jaq_captcha_verify_response>
    <data>
        <extend_data>{&quot;extendKey&quot;: &quot;extendValue&quot;}</extend_data>
        <jaq_dispatch_param>
            <event_id>913235a6-efdc-11e5-8ba5-a0d3c1f1fdf4</event_id>
            <protocol_version>1.0</protocol_version>
            <rtken>NDI3MiZFZG81SVZJVHpYUUwrZlBKVlNPTU1nPT0</rtken>
            <rtken_index>aadffa525022d4d8a2ff15cac28334db</rtken_index>
        </jaq_dispatch_param>
        <verify_status>10</verify_status>
    </data>
</alibaba_security_jaq_captcha_verify_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
isv.param-error 请求参数错误 检查入参
isp.server-error 服务端错误 稍后重试

API工具

如何获得此API

FAQ

返回
顶部