套餐管理：查詢本年度和本月使用情況
更新時間 2025-10-24 11:00:18
最近更新(xin)時(shi)間: 2025-10-24 11:00:18
分享文章
接口功能介紹
調(diao)用此接口(kou)可查詢指定套(tao)餐包(bao)使用數量。
接口約束
參見請求參數說明。
URI
GET /v4/monitor/order/notice-pack-used
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| method | 是 | String | 本參數表示通知套餐包類型。取值范圍： sms：短信通知套餐包。 voice：語音通知套餐包。 根據以上范圍取值。 | voice |
請求參數
請求頭header參數 無
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| packIsAvailable | Boolean | 是否有可用收費套餐包 | true | |
| monthPackCost | Integer | 本月收費套餐包使用量，前提條件需有可用的收費套餐包。 | 500 | |
| monthFreeCost | Integer | 本月免費套餐包使用量 | 100 | |
| monthFreeQuota | Integer | 本月免費套餐包額度 | 500 | |
| yearCost | Integer | 本年使用總量 | 10000 |
枚舉參數
無
請求示例
請求url
/v4/monitor/order/notice-pack-used?method=voice
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"packIsAvailable": true,
"monthFreeCost": 500,
"monthFreeQuota": 1000,
"monthPackCost": 1000,
"yearCost": 10000
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
請參考
錯誤碼
請參考
