更新验证码应用

首页

帮助中心

API

说明： 通过接口更新验证码应用信息。

Url-请求参数说明：

参数	说明	是否必填	类型
appId	应用id，新增时返回	是	String

Body-请求参数说明：

参数	说明	是否必填	类型
name	应用名称，4-32字符，不允许重复	是	String
codeExpiry	发送的验证码的有效期时长，1-60分钟，可选整数值，默认5分钟	否	Int
appId	应用id，新增时返回	是	String
periodTotalSendLimit	周期内发送的数量限制	否	JSONObject
enabled	启用开关，默认关闭	否	Boolean
unit	周期单位：1-day,2-hour,3-minute,4-second，enabled为开启时，此参数变为必填	否	Int
period	周期1-90，enabled为开启时，此参数变为必填	否	Int
limit	限制1-100亿，enabled为开启时，此参数变为必填	否	Int
periodPhoneSendLimit	周期内向同号码发送的频繁限制	否	JSONObject
enabled	启用开关，默认关闭	否	Boolean
unit	周期单位：1-day,2-hour,3-minute,4-second，enabled为开启时，此参数变为必填	否	Int
period	周期1-90，enabled为开启时，此参数变为必填	否	Int
limit	限制1-100亿，enabled为开启时，此参数变为必填	否	Int

请求URL：

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

请求示例：

                                                
                                                    Request URL:
                                                        https://api.onbuka.com/v3/otp/app/update/mRELxtHc
                                                    Request Method:
                                                        PUT
                                                    Request Headers:
                                                        Content-Type: application/json;charset=UTF-8
                                                        Sign: 05d7a50893e22a5c4bb3216ae3396c7c
                                                        Timestamp: 1630468800
                                                        Api-Key: bDqJFiq9
                                                    Request Body:
                                                        {
                                                            "name":"test_app",
                                                            "codeExpiry":5,
                                                            "appId":"mRELxtHc",
                                                            "periodTotalSendLimit":{
                                                                "enabled":true,
                                                                "unit":1,
                                                                "period":7,
                                                                "limit":50000
                                                            },
                                                            "periodPhoneSendLimit":{
                                                                "enabled":false,
                                                                "unit":null,
                                                                "period":null,
                                                                "limit":null
                                                            }
                                                        }

响应参数说明：

参数	说明	类型
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"
                                                        }
                                                    }

上一篇：新增验证码应用

下一篇：验证码应用详情

意见反馈

文档内容是否对您有帮助？