套餐管理:配置月度使用上限
更新时间 2025-10-24 10:59:55
最近更新时间: 2025-10-24 10:59:55
接口功能介绍
调用此接口可对通知套餐包设置自定义限流,只适用于收费通知套餐包。
接口约束
参见请求参数说明。
URI
POST /v4/monitor/order/notice-pack-set-limit
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| method | 是 | String | 本参数表示通知套餐包类型。取值范围: sms:短信通知套餐包。 voice:语音通知套餐包。 根据以上范围取值。 | voice | |
| monthLimit | 是 | Integer | 本参数表示月限流数量。取值范围:0-5000,0代表不限流。 | 1000 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
| errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
| message | String | 失败时的错误描述,一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述,适配中英文 | 成功 | |
| description | String | 失败时的错误描述,适配中英文 | 成功 | |
| error | String | 错误码,请求成功时,不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Array of Objects | 返回参数,参考returnObj对象结构 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
枚举参数
无
请求示例
请求url
/v4/monitor/order/notice-pack-set-limit
请求头header
无
请求体body
{
"method": "voice",
"monthLimit": 1000
}
响应示例
{
"statusCode": 800,
"returnObj": {
"success": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码