API Center/Add Verification Code Template
 

Add Verification Code Template

POST

https://api.itniotech.com/otp/template/add

Create a verification code template through the API.
 
Request Parameters
appId
String
Required
Application id
name
String
Required
Template name, 4-32 characters, and not allow to duplicate
text
String
Required
Template content, 1-256 characters, the template content must contain ##code##
codeType
Int
Verification code length [4, 10], default 4
codeLength
Int
Verification code length [4, 10], default 4
speechRate
Int
Speech rate [0, 100], default 50
language
String
Language { Chinese: CN, English: EN, Vietnamese: VN, Japanese: JP, Arabic: ARB German: DE, Hindi: IN, Italian: IT, Korean: KR, Russian: RU, Spanish: ES, Portuguese: PT, Indonesian: IDN, Bangladesh: BD } and it is EN by default
maxDuration
Int
Maximum call duration [5, 599] seconds, and it is 59 seconds by default
repeatCnt
Int
Play times [1, 10], and play 1 time by default
senderId
String
Sender id
 
Request Sample
Request URL:
    https://api.itniotech.com/otp/template/add
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "appId":"mRELxtHc",
    "name":"name",
    "text":" ##code## is your verification,expires in 5 minutes! ",
    "codeType":1,
    "codeLength":4,
    "speechRate":50,
    "language":"EN",
    "maxDuration":59,
    "repeatCnt":1,
    "senderId":"senderId"
}
 
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 {CN, EN, JP, VN} 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
Details of Verification Code Application
Update Verification Code Template

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

    final String url = baseUrl.concat("/template/add");
    final String name = "{{name}}";
    final String text = "{{text}}";
    final Integer codeType = "{{codeType}}";
    final Integer codeLength = "{{codeLength}}";
    final Integer speechRate = "{{speechRate}}";
    final String language = "{{language}}";
    final Integer maxDuration = "{{maxDuration}}";
    final Integer repeatCnt = "{{repeatCnt}}";
    final String senderId = "{{senderId}}";

    System.out.println(url);
    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("appId", appId)
            .set("name", name)
            .set("text", text)
            .set("codeType", codeType)
            .set("codeLength", codeLength)
            .set("speechRate", speechRate)
            .set("language", language)
            .set("maxDuration", maxDuration)
            .set("repeatCnt", repeatCnt)
            .set("senderId", senderId)
            .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";
$appId = "{{appId}}";

$url = "https://api.itniotech.com/otp/template/add";

$timeStamp = time();
$sign = md5($apiKey.$apiSecret.$timeStamp);

$dataArr['appId'] = $appId;
$dataArr['name'] = "{{name}}";
$dataArr['text'] = "{{text}}";
$dataArr['codeType'] = "{{codeType}}";
$dataArr['codeLength'] = "{{codeLength}}";
$dataArr['speechRate'] = "{{speechRate}}";
$dataArr['language'] = "{{language}}";
$dataArr['maxDuration'] = "{{maxDuration}}";
$dataArr['repeatCnt'] = "{{repeatCnt}}";
$dataArr['senderId'] = "{{senderId}}";

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