API中心/查询验证码模板集合
 
 

查询验证码模板集合

GET
https://api.itniotech.com/otp/template/list
获得当前用户下所有验证码模板。
 
请求示例
Request URL:
    https://api.itniotech.com/otp/template/list
Request Method:
    GET
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
 
响应参数
参数 说明 类型
status 状态码，0成功，其他失败参见响应状态码说明 String
reason 失败原因说明 String
data 响应参数详情 JSONObject
templateId 模板id Int
appId 应用id String
name 模板名称 String
text 模板内容 String
codeType 验证码类型：1.NUMERIC, 2.ALPHA, 3.ALPHANUMERIC, 4.HEX Int
codeLength 验证码长度[4, 10] Int
speechRate 语速[0， 100] Int
language 语言{CN, EN, JP, VN} String
maxDuration 最大通话时长[5，599]秒， Int
repeatCnt 播放次数[1，10] Int
senderId 发送者id String
 
响应状态码
status 状态说明
0 成功
-1 账号认证异常
-2 ip限制
-16 时间戳过期
-18 系统异常
-20 数据已存在
-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 getTemplateList() {
    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("/template/list");
    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";

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

$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"
        }
    ]
}