API中心/校验验证码
 
 

校验验证码

POST
https://api.itniotech.com/otp/verification/verify
通过接口校验指定消息id验证码是否正确。
 
请求参数
verificationId
String
必填
消息id
code
String
必填
验证码，4-10字符
 
请求示例
Request URL:
    https://api.itniotech.com/otp/verification/verify
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "verificationId":"22206051443051000003",
    "code":"5863"
}
 
响应参数
参数 说明 类型
status 状态码，0成功，其他失败参见响应状态码说明 String
reason 失败原因说明 String
data 响应参数详情 JSONObject
verificationId 消息id String
to 接收号码 String
channel 通道类型 [sms, call, sna] String
matched 验证码的检验结果[ -1未校验、0校验成功、 1发送中、2校验失败、3不存在的verificationId、4已使用的verificationId、5验证码超时 ] Int
 
响应状态码
status 状态说明
0 成功
-1 账号认证异常
-2 ip限制
-16 时间戳过期
-18 系统异常
-22 参数异常
重发验证码
验证码记录详情

意见反馈

文档内容是否对您有帮助?

 

LANGUAGE

Java

PHP

REQUEST

 import cn.hutool.crypto.SecureUtil;
 import cn.hutool.http.Header;
 import cn.hutool.http.HttpRequest;
 import cn.hutool.http.HttpResponse;
 import cn.hutool.json.JSONUtil;

 import java.time.LocalDateTime;
 import java.time.ZoneId;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;

private void verify() {
    final String baseUrl = "https://api.itniotech.com/otp";
    final String apiKey = "your api key";
    final String apiPwd = "your api secret";

    final String url = baseUrl.concat("/verification/verify");
    final String verificationId = "{{verificationId}}";
    final String code = "{{code}}";

    HttpRequest request = HttpRequest.post(url);

    // currentTime
    final String datetime = String.valueOf(LocalDateTime.now().atZone(ZoneId.systemDefault()).toInstant().getEpochSecond());
    // generate md5 key
    final String sign = SecureUtil.md5(apiKey.concat(apiPwd).concat(datetime));
    request.header(Header.CONNECTION, "Keep-Alive")
            .header(Header.CONTENT_TYPE, "application/json;charset=UTF-8")
            .header("Sign", sign)
            .header("Timestamp", datetime)
            .header("Api-Key", apiKey);

    final String params = JSONUtil.createObj()
            .set("verificationId", verificationId)
            .set("code", code)
            .toString();
    HttpResponse response = request.body(params).execute();
    if (response.isOk()) {
        String result = response.body();
        System.out.println(result);
    }
}

REQUEST

header('content-type:text/html;charset=utf8');

$apiKey = "your api key";
$apiSecret = "your api secret";

$url = "https://api.itniotech.com/otp/verification/verify";
$timeStamp = time();
$sign = md5($apiKey.$apiSecret.$timeStamp);

$dataArr['verificationId'] = "{{verificationId}}";
$dataArr['code'] = "{{code}}";

$data = json_encode($dataArr);
$headers[] = 'Content-Type: application/json;charset=UTF-8';
$headers[] = "Sign: $sign";
$headers[] = "Timestamp: $timeStamp";
$headers[] = "Api-Key: $apiKey";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 600);
curl_setopt($ch, CURLOPT_HTTPHEADER,$headers);
curl_setopt($ch, CURLOPT_POSTFIELDS , $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);

$output = curl_exec($ch);
curl_close($ch);

var_dump($output);
 

RESPONSEEXAMPLE

{
    "status": "0",
    "reason": "success",
    "data": {
        "verificationId": "22206051443051000003",
        "to": "91856321412",
        "channel": "sms",
        "matched": 0
    }
}