短信验证码核验

发送短信验证码

根据手机号、业务码发送短信验证码

一、请求说明

• 请求地址：http://api.spiderid.cn/api/router/rest，https://api.spiderid.cn/api/router/rest
• 服务接口名称(即公共参数method的值)： sms.sendCaptcha
• 请求方式：POST或GET

二、请求参数

• 以下参数不能都为空，请求参数以表单形式提交,Content-Type值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
mobile	String	是	手机号
code	String	是	业务码，业务码请联系相关人员获得
templateParam	Map	否	模板参数，请联系相关人员获得

请求示例：

http或https://api.spiderid.cn/api/router/rest?
mobile=XXX
&code=XXX
&templateParam=XXX
&<[公共请求参数]>

三、响应参数

data结果信息	类型	描述
incorrect	Integer	返回码
message	String	描述

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "ds2d24...",
  "data": {
      "message": "发送成功" ,
      "incorrect": 100 ,
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "ds2d24...",
  "data": {
      "message": "发送失败" ,
      "incorrect": 103
  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述	是否收费
100	发送成功	是
101	发送间隔时间过短，默认为一分钟	否
102	今日发送短信已达最大次数,默认每个手机号在同一个业务码下为10次	否
103	发送失败	否

SDK 请求示例

    //提供的url
    String url = "http://api.spiderid.cn/api/router/rest";
    //您的appKey
    String appkey = "XXX";
    //您的appSecret
    String secretKey = "XXX";

    //短信模板填充内容
    Map<String, String> templateParam = new HashMap<String, String>();
    templateParam.put("XXX", "XXXXX");

    //1.默认客户端
    ApiClient apiClient = new DefaultApiClient(url, appkey, secretKey);
    //2.调用出错自动重试客户端
    //AutoRetryApiClient apiClient = new AutoRetryApiClient(url, appkey, secretKey);
    SmsSendCaptchaRequest req = new SmsSendCaptchaRequest();
    //以下参数必填，不能为空
    req.setMobile("XXXX");
    req.setCode("xxxxx");
    req.setTemplateParam(templateParam);
    
    try{
        SmsSendCaptchaResponse res = apiClient.execute(req);
        //后续业务处理
    }catch(ApiException e){
        e.printStackTrace();
    }

验证码验证

根据验证码、业务码、手机号进行验证

一、请求说明

• 请求地址：http://api.spiderid.cn/api/router/rest，https://api.spiderid.cn/api/router/rest
• 服务接口名称(即公共参数method的值)： sms.verifyCaptcha
• 请求方式：POST或GET

二、请求参数

• 以下参数不能都为空，请求参数以表单形式提交,Content-Type值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
captcha	String	是	验证码
code	String	是	业务码
mobile	String	是	手机号

请求示例：

http或https://api.spiderid.cn/api/router/rest?
captcha=XXX
&code=XXX
&mobile=XXX
&<[公共请求参数]>

三、响应参数

data结果信息	类型	描述
result	String	验证结果

• result 验证结果介绍

字段	状态介绍
SUCCESS	成功
INVALID	失效
FAIL	失败

四、成功示例

JSON示例

{
   "SUCCESS"
}

五、失败示例

JSON示例

{
  "FAIL"
}

SDK 请求示例

    //提供的url
    String url = "http://api.spiderid.cn/api/router/rest";
    //您的appKey
    String appkey = "XXX";
    //您的appSecret
    String secretKey = "XXX";
    
    //1.默认客户端
    ApiClient apiClient = new DefaultApiClient(url, appkey, secretKey);
    //2.调用出错自动重试客户端
    //AutoRetryApiClient apiClient = new AutoRetryApiClient(url, appkey, secretKey);
    SmsCaptchaVerifyRequest req = new SmsCaptchaVerifyRequest();
    //以下参数必填，不能为空
    req.setCaptcha("XXXX");
    req.setMobile("XXXX");
    req.setCode("xxxxx");
    
    try{
        SmsCaptchaVerifyResponse res = apiClient.execute(req);
        //后续业务处理
     }catch(ApiException e){
        e.printStackTrace();
    }