套餐管理：查询语音套餐包列表
更新时间 2025-10-24 11:00:42
最近更新时间: 2025-10-24 11:00:42
接口功能介绍
调用此接口可查询通知套餐包列表。
接口约束
参见请求参数说明。
URI
GET /v4/monitor/order/notice-pack-list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| packType | 是 | String | 通知套餐包类型，取值范围： sms：短信通知套餐包。 voice：语音通知套餐包。 根据以上范围取值。 | sms | |
| packID | 否 | String | 套餐包ID | 000f0922-1f4d-8cc8-bb2e-1c30fb751aa8 | |
| status | 否 | Integer | 此参数表示状态， 取值范围： 1：正常。 2：已用尽。 3：已到期。 4：撤单。 5：退单。 6：冻结。 7：下单中。 根据以上范围取值。 | 1 | |
| sortKey | 否 | String | 排序字段， 配合sortType排序类型使用， 如果没有sortType则默认升序，取值范围： effectiveTime：套餐生效时间。 expireTime：套餐到期时间。 quota：总额度。 used：已使用数量。 orderCtime：订单创建时间。 根据以上范围取值。 | orderCtime | |
| sortType | 否 | String | 排序类型，取值范围： ASC：升序。 DESC：降序。 根据以上范围取值。 | DESC | |
| pageNo | 否 | Integer | 页码，默认值：1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，默认值：10 | 10 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，适配中英文 | 成功 | |
| description | String | 失败时的错误描述，适配中英文 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数，参考returnObj对象结构 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| packList | Array of Objects | 通知套餐包列表 | packObj | |
| currentCount | Integer | 当前页记录数 | 10 | |
| totalCount | Integer | 获取对象数据条数 | 50 | |
| totalPage | Integer | 总页数 | 1 | |
| 表 packObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| packID | String | 通知套餐包ID， 如果值为default，代表免费套餐包。 | 000f0922-1f4d-8cc8-bb2e-1c30fb751aa8 | |
| packType | String | 通知套餐包类型，取值范围： sms：短信通知套餐包。 voice：语音通知套餐包。 根据以上范围取值。 | sms | |
| status | Integer | 此参数表示状态， 取值范围： 1：正常。 2：已用尽。 3：已到期。 6：冻结。 7：下单中。 根据以上范围取值。 | 1 | |
| effectiveTime | Long | 套餐生效时间，毫秒级时间戳 | 1727712000000 | |
| expireTime | Long | 套餐到期时间，毫秒级时间戳 | 1730390399000 | |
| orderCtime | Integer | 订单创建时间，秒级时间戳 | 1727712000 | |
| quota | Integer | 总量 | 1000 | |
| used | Integer | 已用量 | 5 |
枚举参数
无
请求示例
请求url
/v4/monitor/order/notice-pack-list?packType=sms
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"packList": [
{
"packType": "sms",
"status": 1,
"effectiveTime": 1727712000,
"expireTime": 1730390399,
"orderCtime": 1727712000,
"quota": 1000,
"used": 0,
"packID": "default"
}
],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码
