API Center/Query the Details of a Single Verification Code Te

Query the Details of a Single Verification Code Template

GET

https://api.itniotech.com/otp/template/details/{templateId}

Obtain the details of the specified verification code template through the API.
Request Parameters
templateId
Int
Required
Template id
Request Sample
Request URL:
    https://api.itniotech.com/otp/template/details/455
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
templateId Template id Int
appId Application id String
name Template name String
text Template content String
codeType Verification code type: 1.NUMERIC, 2.ALPHA, 3.ALPHANUMERIC, 4.HEX Int
codeLength Verification code length [4, 10] Int
speechRate Speech rate [0, 100] Int
language Language { String
maxDuration Maximum call duration [5,599] seconds Int
repeatCnt Play times [1, 10] Int
senderId Sender id String
Response Status Code
status Description
0 success
-1 Authentication error
-2 Restricted IP access
-16 Timestamp expires
-18 Port program unusual
-20 Data existing
-22 Parameter exception
Query Verification Code Template Collection
Send the Verification Code

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

    final String templateId = "{{templateId}}";
    final String url = baseUrl.concat("/template/details/").concat(templateId);
    HttpRequest request = HttpRequest.get(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";

$templateId = "{{templateId}}";
$url = "https://api.itniotech.com/otp/template/details/".$templateId;

$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": {
        "templateId":455,
        "appId":"mRELxtHc",
        "name":"name",
        "text":"text",
        "codeType":1,
        "codeLength":4,
        "speechRate":50,
        "language":"EN",
        "maxDuration":59,
        "repeatCnt":1,
        "senderId":"senderId"
    }
}