API Center/Details of Verification Code Record
 

Details of Verification Code Record

GET

https://api.itniotech.com/otp/verification/record/{verificationId}

Query the details of the specified message id record through the API.
 
Request Parameters
verificationId
String
Required
Message id
 
Request Sample
Request URL:
    https://api.itniotech.com/otp/verification/record/22206051443051000003
Request Method:
    GET
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
 
Response Parameters
Parameters Description Type
status Status code, 0 is successful, other failures refer to description of status code String
reason Description of failure reason String
data Details of response parameters JSONObject
verificationId Message id String
verifications Details of verification result JSONObject
matched Verification result of verification code [0 verification successful, -1 not verified, 1 sending, 2 verification failed, 3 non-existent verificationId] Int
verifiedDate Verification time String
oriReceiver Receiving number String
channel Channel type [sms, call, sna] String
orderId The serial number of the third-party platform, which needs to be globally unique String
sms SMS record details, verifications.channel=sms, return this object JSONObject
submitTm Submission time String
sendTm Sending time String
doneTm Completion time String
mcc mcc Int
mnc mnc Int
sender Sender id String
chargeCnt Number of billing entries Int
pay Total cost String
status SMS sending status - 1 sending 0 success 1 failure Int
reason Description of failure reason  
call Voice record details, verifications.channel=call, return this object JSONObject
terminationCode Send status 0 success other failure Int
terminationReason Description of status code String
submitTime Submission time String
callTime Call time String
ringingTime Ring time String
answerTime Answer time String
hangupTime Hang-up time String
callDuration Call duration Int
chargedDuration Charge duration Int
displayNum Display number String
billPeriodstring Billing period String
code Regional suppliers String
rate Rate String
cost Amount of consumptionate(Quotation currency) String
sna Silent Network Authentication (SNA) Login Record Details, with verifications.channel=sna, return this object JSONArray
postVerificationTime Request verification time String
verificationBackTime Verification result return time String
mcc mcc Integer
mnc mnc Integer
status Verification status [-1 not verified, 0 successful, 1 failed] Integer
reason Reason description String
 
Response Status Code
status Description
0 success
-1 Authentication error
-2 Restricted IP access
-16 Timestamp expires
-18 Port program unusual
-22 Parameter exception
Check Verification Code
New Task Flow

Feedback

Was this page helpful?

 

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 getRecord() {
    final String baseUrl = "https://api.itniotech.com/otp";
    final String apiKey = "your api key";
    final String apiPwd = "your api secret";

    final String verificationId = "{{verificationId}}";
    final String url = baseUrl.concat("/verification/record/").concat(verificationId);
    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);

    HttpResponse response = request.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";

$verificationId = "{{verificationId}}";
$url = "https://api.itniotech.com/otp/verification/record/".$verificationId;

$timeStamp = time();
$sign = md5($apiKey.$apiSecret.$timeStamp);
$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_CONNECTTIMEOUT, 600);
curl_setopt($ch, CURLOPT_HTTPHEADER,$headers);
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": "verificationId",
        "verifications":{
            "matched":0,
            "verifiedDate":"2022-01-01T00:00:10+08:00",
            "oriReceiver":"91856321412",
            "channel":"sms",
            "orderId":null
        },
        "sms": {
            "submitTm":"2022-01-01T00:00:00+08:00",
            "sendTm":"2022-01-01T00:00:01+08:00",
            "doneTm":"2022-01-01T00:00:02+08:00",
            "mcc":404,
            "mnc":-1,
            "sender":null,
            "chargeCnt":2,
            "pay":"0.015",
            "status":0,
            "reason":"success"
        },
        "call": null
    }
}