套餐管理：查詢語音套餐包列表
更(geng)新時間 2025-10-24 11:00:42
最近(jin)更新時(shi)間(jian): 2025-10-24 11:00:42
分享(xiang)文章
接口功能介紹
調用此接口可查詢通知套餐包列表。
接口約束
參見請求參數說明。
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": "成功"
}
狀態碼
請參考
錯誤碼
請參考
