七月迭代短暂完结,还有很多后端的关键东西没有弄,这是一版赶时间做的东西
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 8m26s
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 8m26s
This commit is contained in:
@@ -5,8 +5,8 @@
|
||||
本文档提供 Gateway 客户端所有 API 接口的完整参考,包括请求参数、响应格式和使用示例。
|
||||
|
||||
**API 分类**:
|
||||
- 流量卡管理(7 个接口)
|
||||
- 设备管理(7 个接口)
|
||||
- 流量卡管理(8 个接口)
|
||||
- 设备管理(6 个接口)
|
||||
|
||||
**基础信息**:
|
||||
- 协议:HTTPS
|
||||
@@ -270,7 +270,43 @@ fmt.Printf("实名链接: %s\n", resp.Link)
|
||||
|
||||
---
|
||||
|
||||
### 7. 批量查询(预留)
|
||||
### 7. 设置流量卡固定限速档位
|
||||
|
||||
按 ICCID 设置或恢复流量卡固定限速档位。Gateway 不提供设备限速能力,禁止传入设备 ID、IMEI 或通过设备绑定关系间接调用。
|
||||
|
||||
**方法**: `SetCardSpeedTier`
|
||||
|
||||
**请求参数**:
|
||||
```go
|
||||
type CardSpeedTierReq struct {
|
||||
CardNo string `json:"cardNo" validate:"required"`
|
||||
Code string `json:"code" validate:"required"`
|
||||
}
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| CardNo | string | ✅ | 流量卡 ICCID |
|
||||
| Code | string | ✅ | 固定档位编码:`-1` 恢复不限速,`0` 0kbps,`1` 128Kbps,`2` 512Kbps,`3` 1Mbps,`4` 2Mbps,`5` 10Mbps,`6` 20Mbps,`7` 50Mbps,`8` 100Mbps |
|
||||
|
||||
**响应参数**: 无(成功返回 nil,失败返回 error)
|
||||
|
||||
**使用示例**:
|
||||
```go
|
||||
err := client.SetCardSpeedTier(ctx, &gateway.CardSpeedTierReq{
|
||||
CardNo: "898608070422D0010269",
|
||||
Code: "3",
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Println("流量卡固定限速档位设置成功")
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 8. 批量查询(预留)
|
||||
|
||||
批量查询流量卡信息(暂未实现)。
|
||||
|
||||
@@ -427,48 +463,7 @@ for _, slot := range resp.Slots {
|
||||
|
||||
---
|
||||
|
||||
### 3. 设置设备限速
|
||||
|
||||
设置设备的上行和下行速率限制。
|
||||
|
||||
**方法**: `SetSpeedLimit`
|
||||
|
||||
**请求参数**:
|
||||
```go
|
||||
type SpeedLimitReq struct {
|
||||
DeviceID string `json:"deviceId" validate:"required"`
|
||||
UploadSpeed int `json:"uploadSpeed" validate:"required,min=1"`
|
||||
DownloadSpeed int `json:"downloadSpeed" validate:"required,min=1"`
|
||||
Extend string `json:"extend,omitempty"`
|
||||
}
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| DeviceID | string | ✅ | 设备 ID/IMEI |
|
||||
| UploadSpeed | int | ✅ | 上行速率(KB/s),最小1 |
|
||||
| DownloadSpeed | int | ✅ | 下行速率(KB/s),最小1 |
|
||||
| Extend | string | ❌ | 扩展字段 |
|
||||
|
||||
**响应参数**: 无(成功返回 nil,失败返回 error)
|
||||
|
||||
**使用示例**:
|
||||
```go
|
||||
err := client.SetSpeedLimit(ctx, &gateway.SpeedLimitReq{
|
||||
DeviceID: "123456789012345",
|
||||
UploadSpeed: 100,
|
||||
DownloadSpeed: 500,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Println("限速设置成功")
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 4. 设置设备 WiFi
|
||||
### 3. 设置设备 WiFi
|
||||
|
||||
设置设备的 WiFi 信息。
|
||||
|
||||
@@ -516,7 +511,7 @@ fmt.Println("WiFi设置成功")
|
||||
|
||||
---
|
||||
|
||||
### 5. 设备切换卡
|
||||
### 4. 设备切换卡
|
||||
|
||||
切换设备当前使用的卡到指定的目标卡。
|
||||
|
||||
@@ -554,7 +549,7 @@ fmt.Println("切换卡成功")
|
||||
|
||||
---
|
||||
|
||||
### 6. 设备恢复出厂设置
|
||||
### 5. 设备恢复出厂设置
|
||||
|
||||
将设备恢复到出厂设置状态。
|
||||
|
||||
@@ -589,7 +584,7 @@ fmt.Println("恢复出厂设置成功")
|
||||
|
||||
---
|
||||
|
||||
### 7. 设备重启
|
||||
### 6. 设备重启
|
||||
|
||||
远程重启设备。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user