剩余可用流量查询
通过登录所获取的 token,查询用户下流量包详情。请先完成 登录获取 token。
接口描述
| 项目 | 说明 |
|---|---|
| 方法 | POST |
| 地址 | https://api2.ipmart.io/ipmart/common/getPlans |
| 简要描述 | 通过登录所获取的 token,查询用户下流量包详情 |
输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| token | 是 | String | 请求头中的用户访问令牌(可通过 登录接口 获取) |
重要输出参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| status | 是 | Int | 返回码 |
| errorMsg | 否 | String | 错误信息 |
| usage | 否 | String | 使用量 |
| usageGb | 否 | String | 使用量(GB) |
| startTime | 否 | Long | 开始时间戳 |
| endTime | 否 | Long | 到期时间戳 |
| name | 否 | String | 流量包名称 |
| active | 否 | String | 是否启用 |
| overUsage | 否 | String | 是否超额使用 |
发送示例
json
{}请求体可为空对象;token 放在请求头中传递。
返回示例
成功
json
{
"status": 200,
"errorMsg": null,
"data": [
{
"id": "909180",
"createTime": 1712239093881,
"deletedTime": 0,
"deleted": 0,
"userId": "660d5ba8ce87051b5361100b",
"usage": "0.00",
"usageGb": "0",
"startTime": 1713752043823,
"endTime": 1713751567374,
"subscriptionBandwidthGb": 1,
"name": "Trial",
"active": false,
"overUsage": false
},
{
"id": "909181",
"createTime": 1712239093879,
"deletedTime": 0,
"deleted": 0,
"userId": "660d5ba8ce87051b5361100b",
"usage": "1403487.00",
"usageGb": "81.81",
"startTime": 1713752043823,
"endTime": 1713751567374,
"subscriptionBandwidthGb": 200,
"name": "allocation-200",
"active": true,
"overUsage": false
}
]
}失败
json
{
"status": 400,
"errorMsg": "权限错误,请从新登陆",
"data": null
}流量状态描述
| 状态 | active | overUsage | 含义 |
|---|---|---|---|
| 使用中 | true | false | 流量包正在使用中 |
| 未使用 | false | false | 流量包尚未使用 |
| 已用完 | false | true | 流量包已经使用完成 |
账户剩余流量
单位:GB。
text
账户剩余流量 =
使用中的(subscriptionBandwidthGb - usageGb)
+ 未使用流量包的 subscriptionBandwidthGb即:正在使用中的(总流量 − 已使用流量)+ 全部未使用流量包的总流量。
