首页 帮助中心 API

验证码应用详情

说明: 通过接口获得指定验证码应用详情。

请求参数说明:

参数 说明 是否必填 类型

appId

应用id

String

请求URL:

                                
                                  https://api.onbuka.com/v3/otp/app/details/{appId}
                                
                            

请求示例:

                                                
                                                    Request URL:
                                                        https://api.onbuka.com/v3/otp/app/details/mRELxtHc
                                                    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

   name

应用名称

String

   codeExpiry

发送的验证码的有效期时长

Int

   appId

应用id

String

   createTime

创建时间

String

   periodTotalSendLimit

周期内发送的数量限制详情

JSONObject

      unit

周期单位

Int

      period

周期

Int

      limit

限制

Int

      enabled

启用开关

Boolean

   periodPhoneSendLimit

周期内向同号码发送的频繁限制详情

JSONObject

      unit

周期单位

Int

      period

周期

Int

      limit

限制

Int

      enabled

启用开关

Boolean

响应示例:

                                                
                                                    {
                                                        "status": "0",
                                                        "reason": "success",
                                                        "data": {
                                                            "name": "test_app",
                                                            "appId": "mRELxtHc",
                                                            "periodTotalSendLimit": {
                                                                "unit": 1,
                                                                "period": 7,
                                                                "limit": 50000,
                                                                "enabled": true
                                                            },
                                                            "periodPhoneSendLimit": {
                                                                "unit": null,
                                                                "period": null,
                                                                "limit": null,
                                                                "enabled": false
                                                            },
                                                            "codeExpiry": 5,
                                                            "createTime": "2022-01-01T00:00:00+08:00"
                                                        }
                                                    }
                                                
                            
 

意见反馈

0/500