说明: 通过接口创建验证码模板。
参数 | 说明 | 是否必填 | 类型 |
---|---|---|---|
appId |
应用id,新增应用时返回 |
是 |
String |
name |
模板名称,4-32字符,不允许重复 |
是 |
String |
text |
模板内容,1-256字符,模板内容必须包含##code## |
是 |
String |
codeType |
验证码类型:1.NUMERIC, 2.ALPHA, 3.ALPHANUMERIC, 4.HEX,默认1 |
是 |
Int |
codeLength |
验证码长度[4, 10],默认4 |
否 |
Int |
speechRate |
语速[0, 100],默认50 |
否 |
Int |
language |
语言 { |
否 |
String |
maxDuration |
最大通话时长[5,599]秒,默认59秒 |
否 |
Int |
repeatCnt |
播放次数[1,10],默认播放1次 |
否 |
Int |
senderId |
发送者id |
否 |
String |
https://api.onbuka.com/v3/otp/template/add
Request URL:
https://api.onbuka.com/v3/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":"demo",
"text":" ##code## is your verification,expires in 5 minutes! ",
"codeType":1,
"codeLength":4,
"speechRate":50,
"language":"EN",
"maxDuration":59,
"repeatCnt":1,
"senderId":"BUKA"
}
参数 | 说明 | 类型 |
---|---|---|
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",
"reason": "success",
"data": {
"templateId":1,
"appId":"mRELxtHc",
"name":"demo",
"text":" ##code## is your verification,expires in 5 minutes! ",
"codeType":1,
"codeLength":4,
"speechRate":50,
"language":"EN",
"maxDuration":59,
"repeatCnt":1,
"senderId":"BUKA"
}
}