首页 帮助中心 API

查询验证码模板集合

说明: 获得当前用户下所有验证码模板。

请求URL:

                                
                                  https://api.onbuka.com/v3/otp/template/list
                                
                            

请求示例:

                                                
                                                    Request URL:
                                                        https://api.onbuka.com/v3/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,
  越南语:VN,
  日语:JP,
  阿拉伯语:ARB,
  德国:DE,
  印地语:IN,
  意大利:IT,
  韩国:KR,
  俄罗斯:RU,
  西班牙:ES,
  葡萄牙:PT,
  印尼语:IDN,
  孟加拉:BD
}

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

意见反馈

0/500