API文档

接口详情

接口目录

基础说明

通用请求参数
通用响应结构
池中池 OpenAPI 规则
账单提取配置 OpenAPI 规则

接口列表

下面的接口详情默认折叠，点击接口标题可展开完整请求、响应和字段说明。

1. 心跳检测
2. 获取可对接套餐列表
3. 卡板信息查询
4. 获取卡板实名链接
5. 刷新卡板流量
6. 卡板复机
7. 卡板停机
8. 卡板套餐订购
9. 获取移动 Token
10. 设备信息查询
11. 获取设备实名链接
12. 设备套餐订购
13. 设备操作指令
14. 查询代理余额

本文档说明当前开放接口。除心跳接口和“获取移动 Token”外，OpenAPI 请求都需要携带通用签名参数。

“获取移动 Token”是本页第 9 个独立开放接口，使用渠道专属 key 鉴权且不需要签名；也可参阅独立的获取移动 Token菜单。二次认证信息通过单一接口 /api/v1/secondary-auth 获取，请求参数 key 使用渠道配置的 channel_key，不需要签名；请参阅获取二次认证信息。

通用请求参数

参数名	类型	必需	描述	示例
`access_key`	string	是	访问密钥	`ak_test123`
`timestamp`	string	是	Unix 时间戳，单位秒	`1730619000`
`nonce`	string	是	随机字符串，建议每次请求唯一	`test123`
`signature`	string	是	HMAC-SHA256 签名	`abc123def456`

GET 接口使用 Query String 传参。POST 接口支持 application/json 和 application/x-www-form-urlencoded。

通用响应结构

成功响应：

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": {'{'}{'}'},
  "ok": true
{'}'}

失败响应：

{'{'}
  "code": "InvalidParams",
  "msg": "提交的参数不符合要求",
  "ok": false
{'}'}

常见错误码：

code	HTTP 状态码	描述
`InvalidParams`	400	参数缺失、格式错误或资源编号不存在
`BadRequest`	400	业务规则不满足，例如需要先充值后实名
`AlreadyVerified`	400	已完成实名认证
`PermissionDenied`	403	没有操作权限
`Forbidden`	403	无法访问当前资源，需要根据响应中的 `msg` 区分池中池欠费和账单提取配置封禁
`InternalError`	500	系统内部错误或上游接口异常

Forbidden 场景的报错信息分开返回：

拦截来源	`msg`	影响范围
池中池欠费	`池中池已欠费（余额低于保证金），OpenAPI 已暂停，请先充值或补足余额`	当前客户/代理的 OpenAPI
账单提取配置卡板封禁	`账单提取配置已禁止该卡板调用接口`	配置直接绑定的当前卡板
账单提取配置设备封禁	`账单提取配置已禁止该设备调用接口`	配置直接绑定的当前设备

如果同一请求同时命中池中池欠费和账单提取配置封禁，系统先执行池中池的代理级检查，因此返回池中池欠费提示。

池中池 OpenAPI 规则

池中池不改变接口路径、签名方式和通用参数，但会影响卡板流量口径、停复机校验和所属客户的 OpenAPI 可用状态。

场景	规则
卡板命中池中池	卡板被绑定到启用中的池子，或卡板所属客户和渠道命中启用中的渠道范围池。
欠费拦截	当前按客户/代理维度拦截。同一客户名下任一启用池子欠费并触发 OpenAPI 暂停后，该客户的 OpenAPI 请求会返回 `Forbidden`。
欠费判断	池子余额低于保证金时视为欠费；充值或补足余额后可恢复 OpenAPI 调用。
卡板信息流量	池中池卡板的 `used_flow` 返回运营商上游数据中的已用流量；普通卡板返回本地统计的已用流量。
扣费方式	池中池余额不在接口查询或轮询时实时扣费，由后台定时任务处理昨天流量，并由月结流程结算周期差额。
停复机	欠费拦截通过后，池中池卡板可以正常调用停复机接口；复机不因为没有单卡订单而被阻断。
套餐订购	套餐订购接口创建普通卡板套餐订单；池中池日扣费和月结不依赖下游通过该接口下单。

池中池欠费拦截示例：

{'{'}
  "code": "Forbidden",
  "msg": "池中池已欠费（余额低于保证金），OpenAPI 已暂停，请先充值或补足余额",
  "ok": false
{'}'}

账单提取配置 OpenAPI 规则

账单提取配置的“禁止调用接口”按配置绑定对象生效，不会封禁同一客户/代理名下的全部 OpenAPI。

场景	规则
执行时点	配置勾选“禁止调用接口”后，使用该配置成功提取账单时执行。该动作与池中池余额、保证金判断无关。
卡板配置	仅拦截该配置直接绑定卡板的卡板 OpenAPI，其他卡板和设备不受影响。
设备配置	仅拦截该配置直接绑定设备的设备 OpenAPI，其他设备和卡板不受影响。
精确匹配	卡板与设备按配置类型和绑定对象精确匹配；不根据设备及其槽位卡的绑定关系相互推导。
无对象接口	心跳、套餐列表、库存列表等不指定 `card_no` 或 `device_no` 的接口不受影响。
恢复访问	取消配置的“禁止调用接口”动作、将对象从配置解绑，或删除配置后，对应对象不再命中该拦截。

卡板被拦截时：

{'{'}
  "code": "Forbidden",
  "msg": "账单提取配置已禁止该卡板调用接口",
  "ok": false
{'}'}

设备被拦截时：

{'{'}
  "code": "Forbidden",
  "msg": "账单提取配置已禁止该设备调用接口",
  "ok": false
{'}'}

1. 心跳检测 GET /api/v1/heartbeat

1. 心跳检测

检测服务是否正常运行，返回服务器当前时间。

请求信息

项	值
方法	`GET`
路径	`/api/v1/heartbeat`
参数	通用签名参数

请求示例

GET /api/v1/heartbeat?access_key=ak_test123&timestamp=1730619000&nonce=test123&signature=abc123def456
Host: your-domain.com

响应示例

2026-05-03T16:30:00+08:00

2. 获取可对接套餐列表 GET /api/v1/packages

2. 获取可对接套餐列表

查询当前 API 账号可对接的套餐列表。

请求信息

项	值
方法	`GET`
路径	`/api/v1/packages`
参数格式	Query String

业务参数

参数名	类型	必需	描述	示例
`package_code`	string	否	套餐编码，支持模糊筛选	`pkg_d4k9...`

请求示例

GET /api/v1/packages?package_code=pkg_d4k9...&access_key=ak_test123&timestamp=1730619000&nonce=test123&signature=abc123def456
Host: your-domain.com

响应示例

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": [
    {'{'}
      "id": 100,
      "upstream_package_code": "PKG001",
      "package_code": "pkg_d4k9...",
      "name": "联通月包10G",
      "description": "月租套餐",
      "launched": true,
      "operators": ["CUCC"],
      "weight": 100,
      "price": 19.9,
      "cost": 15,
      "low_price": 0,
      "high_price": 99,
      "total_flow": 10240,
      "can_buy_next_month": true,
      "type": "0",
      "buy_limit": 0,
      "day": 2,
      "cycle": 1,
      "unlimited": false,
      "daytime": 1,
      "add_time": 2,
      "flow_slicing_strategy": 0,
      "flow_slicing_count": 0,
      "series_name": "联通标准系列"
    {'}'}
  ],
  "ok": true
{'}'}

说明

仅返回当前 API 账号有权限对接的已上架套餐。
total_flow 返回展示流量。
series_name 只返回系列名称，不返回完整系列配置。
package_code 为空时返回全部可对接套餐。

data 数组字段说明

字段	类型	说明
`id`	number	套餐 ID。该值是当前系统内套餐的唯一标识，仅用于展示或排查，不作为下单参数。
`upstream_package_code`	string	上游套餐编码。仅用于识别上游套餐，不作为下单参数。
`package_code`	string	套餐编码。下单时传 `package_code`。
`name`	string	套餐名称。用于展示给用户。
`description`	string	套餐描述或套餐备注。可能为空字符串。
`launched`	bool	是否已上架。`true` 表示当前套餐可对接、可下单。
`operators`	string[]	套餐支持的运营商列表。返回的是运营商编码数组。
`weight`	number	套餐权重。通常用于前端排序，值越大通常越靠前。
`price`	number	套餐销售价。单位为元。
`cost`	number	套餐成本价。单位为元。
`low_price`	number	套餐允许的最低售价。单位为元。
`high_price`	number	套餐允许的最高售价。单位为元。
`total_flow`	number	套餐总流量，单位为 MB。
`can_buy_next_month`	bool	是否支持购买“次月生效”套餐。`true` 表示下单时可传 `strategy=2`。
`type`	string	套餐类型。`"0"` 表示基础套餐，`"1"` 表示加油包。
`buy_limit`	number	购买次数限制。`0` 一般表示不限制；大于 `0` 表示单个对象只能购买指定次数。
`day`	number	套餐结算周期类型。`1`=按天，`2`=按月，`3`=每月 26 号结算。
`cycle`	number	套餐周期数量。需要结合 `day` 一起理解。比如 `day=2` 且 `cycle=1` 表示 1 个月。
`days_strategy`	number	按天套餐的月份天数策略。`1`=严格按 `cycle` 天，`2`=按当月实际天数。使用 `2` 时 `cycle` 必须是 `30` 的倍数。未返回或为 `0` 时按严格天数处理。
`unlimited`	bool	是否为无限流量套餐。`true` 表示无限流量，`false` 表示非无限流量。
`daytime`	number	套餐结算时间规则。`1`=在结算日当天结束时失效，`2`=在结算日的订购时间点失效。
`add_time`	number	套餐时间叠加规则。`1`=无限叠加时间，`2`=立即生效，`3`=前一个套餐失效。
`flow_slicing_strategy`	number	流量切片策略。`0`=不切片，`1`=按结算日自动切片，`2`=按平均值自动切片。
`flow_slicing_count`	number	流量切片数量。仅当 `flow_slicing_strategy=2` 时有实际意义；其它情况通常为 `0`。
`series_name`	string	套餐所属系列名称。当前开放接口只返回名称，不返回系列完整配置。

operators 字段取值说明

值	说明
`CMCC`	中国移动
`CUCC`	中国联通
`CTCC`	中国电信
`CBNC`	中国广电

补充示例

day=2、cycle=1：表示 1 个月套餐。
day=1、cycle=30：表示 30 天套餐。
day=1、cycle=30、days_strategy=2：按生效开始时间所在月份的实际天数计算。
day=1、cycle=60、days_strategy=2：按连续 2 个自然月的实际天数计算。
can_buy_next_month=true：下游下单时可以传 strategy=2 表示次月生效。
buy_limit=3：表示同一个卡板或设备最多购买 3 次该套餐。

3. 卡板信息查询 GET /api/v1/info

3. 卡板信息查询

查询指定卡板的流量、余额、状态和实名状态。

请求信息

项	值
方法	`GET`
路径	`/api/v1/info`
参数格式	Query String

业务参数

参数名	类型	必需	描述	示例
`card_no`	string	是	卡板编号	`CARD123456789`

请求示例

GET /api/v1/info?card_no=CARD123456789&access_key=ak_test123&timestamp=1730619000&nonce=test123&signature=abc123def456
Host: your-domain.com

响应示例

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": {'{'}
    "card_no": "CARD123456789",
    "total_flow": 10240,
    "used_flow": 5120,
    "status": 2,
    "official_real_name_verified": true,
    "balance": "100.50",
    "delete_on": "2026-06-01T00:00:00+08:00"
  {'}'},
  "ok": true
{'}'}

data 字段说明

字段	类型	描述
`card_no`	string	卡板编号
`total_flow`	number	可用总流量，单位 MB
`used_flow`	number	已使用流量，单位 MB
`status`	int	卡板状态码
`official_real_name_verified`	bool	是否官方实名
`balance`	number	余额
`delete_on`	string	当前在用套餐到期时间，可选

池中池说明

如果 card_no 命中启用中的池中池，used_flow 直接返回运营商上游数据中的已用流量。
total_flow 仍表示本地可用总流量；池中池卡板可能没有单卡套餐订单，delete_on 可能为空。

4. 获取卡板实名链接 GET /api/v1/real-name-url

4. 获取卡板实名链接

获取指定卡板的官方实名链接。

请求信息

项	值
方法	`GET`
路径	`/api/v1/real-name-url`
参数格式	Query String

业务参数

参数名	类型	必需	描述	示例
`card_no`	string	是	卡板编号	`CARD123456789`

请求示例

GET /api/v1/real-name-url?card_no=CARD123456789&access_key=ak_test123&timestamp=1730619000&nonce=test123&signature=abc123def456
Host: your-domain.com

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": "https://example.com/real-name?card_no=CARD123456789",
  "ok": true
{'}'}

业务规则

场景	返回
卡板已官方实名	仍按当前实名模式返回实名链接
套餐系列配置为先充值后实名，且卡板没有已支付订单	`BadRequest`，`msg` 为 `卡板需要先充值后实名`
套餐系列不存在	`DataMissing`
上游获取实名链接失败	`InternalError`，`msg` 带具体失败原因

5. 刷新卡板流量 POST /api/v1/refresh-flow

5. 刷新卡板流量

主动刷新指定卡板的最新流量信息，成功后仅返回成功状态。

请求信息

项	值
方法	`POST`
路径	`/api/v1/refresh-flow`
参数格式	JSON 或 Form

业务参数

参数名	类型	必需	描述	示例
`card_no`	string	是	卡板编号	`CARD123456789`

请求示例

{'{'}
  "card_no": "CARD123456789",
  "access_key": "ak_test123",
  "timestamp": "1730619000",
  "nonce": "test123",
  "signature": "abc123def456"
{'}'}

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "ok": true
{'}'}

6. 卡板复机 POST /api/v1/start

6. 卡板复机

对指定卡板执行复机操作。

请求信息

项	值
方法	`POST`
路径	`/api/v1/start`
参数格式	JSON 或 Form

业务参数

参数名	类型	必需	描述	示例
`card_no`	string	是	卡板编号	`CARD123456789`

权限要求

API 账号必须具有停复机权限。

池中池说明

池中池欠费拦截先于复机业务逻辑执行；如果返回 Forbidden，需要先充值或补足池子余额。
欠费拦截通过后，池中池卡板可以显式复机；复机不会因为没有单卡套餐订单而被阻断。

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": true,
  "ok": true
{'}'}

7. 卡板停机 POST /api/v1/stop

7. 卡板停机

对指定卡板执行停机操作。

请求信息

项	值
方法	`POST`
路径	`/api/v1/stop`
参数格式	JSON 或 Form

业务参数

参数名	类型	必需	描述	示例
`card_no`	string	是	卡板编号	`CARD123456789`

权限要求

API 账号必须具有停复机权限。

池中池说明

池中池欠费拦截先于停机业务逻辑执行；如果返回 Forbidden，需要先充值或补足池子余额。
欠费拦截通过后，池中池卡板可以显式停机；该操作只执行上游停机，不参与池中池余额扣费。

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": true,
  "ok": true
{'}'}

8. 卡板套餐订购 POST /api/v1/orders

8. 卡板套餐订购

为指定卡板订购套餐。

请求信息

项	值
方法	`POST`
路径	`/api/v1/orders`
参数格式	JSON 或 Form

业务参数

参数名	类型	必需	描述	示例
`card_no`	string	是	卡板编号	`CARD123456789`
`package_code`	string	是	套餐编码	`pkg_d4k9...`
`strategy`	uint8	是	生效策略，`1`=本月生效，`2`=次月生效	`1`

请求示例

{'{'}
  "card_no": "CARD123456789",
  "package_code": "pkg_d4k9...",
  "strategy": 1,
  "access_key": "ak_test123",
  "timestamp": "1730619000",
  "nonce": "test123",
  "signature": "abc123def456"
{'}'}

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": {'{'}
    "order_no": "ORD202605030001"
  {'}'},
  "ok": true
{'}'}

业务规则

当前使用余额支付。
余额不足、套餐不可用、卡板状态不满足时会返回失败。
strategy=1 表示本月生效，strategy=2 表示次月生效。
池中池余额扣费由日扣费任务和月结流程处理，不通过本接口扣池子余额。
本接口创建普通卡板套餐订单；池中池卡板没有单卡订单也不会影响池中池日扣费和月结。

9. 获取移动 Token POST /api/v1/token

9. 获取移动 Token

根据渠道 ID 获取移动下游实时 token。

请求信息

项	值
方法	`POST`
路径	`/api/v1/token`
参数格式	JSON 或 Form，无需 OpenAPI 签名参数

业务参数

参数名	类型	必需	描述	示例
`key`	string	是	渠道专属渠道密钥（`channel_key`），仅支持移动渠道	`8d12...a91f`

请求示例

{'{'}
  "key": "8d12...渠道密钥...a91f"
{'}'}

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": {'{'}
    "token": "3d7d94df3cf1e7942efe408ee141cca6"
  {'}'},
  "ok": true
{'}'}

10. 设备信息查询 GET /api/v1/device/info

10. 设备信息查询

查询指定设备信息，包括设备基础信息、流量信息和卡槽信息。

请求信息

项	值
方法	`GET`
路径	`/api/v1/device/info`
参数格式	Query String

业务参数

参数名	类型	必需	描述	示例
`device_no`	string	是	设备编号	`DEVICE123456789`

请求示例

GET /api/v1/device/info?device_no=DEVICE123456789&access_key=ak_test123&timestamp=1730619000&nonce=test123&signature=abc123def456
Host: your-domain.com

响应示例

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": {'{'}
    "device_no": "DEVICE123456789",
    "balance": "50.00",
    "signal": 4,
    "electricity": 85,
    "device_conn_num": 3,
    "wifi_status": 1,
    "hide_wifi": false,
    "wifi_name": "TCZK-5G",
    "used_flow": 1024.5,
    "total_flow": 20480,
    "delete_on": "2026-06-01T00:00:00+08:00",
    "card_slots": [
      {'{'}
        "slot_code": "1",
        "card_no": "8986001234567890123",
        "official_real_name_verified": true,
        "card_status": 2,
        "is_main_slot": true,
        "is_current_slot": true
      {'}'}
    ]
  {'}'},
  "ok": true
{'}'}

data 字段说明

字段	类型	描述
`device_no`	string	设备编号
`balance`	number	设备余额
`signal`	number	信号强度
`electricity`	number	电量
`device_conn_num`	int	当前设备连接数
`wifi_status`	int	WiFi 状态
`hide_wifi`	bool	是否隐藏 WiFi
`wifi_name`	string	WiFi 名称
`used_flow`	number	设备使用流量，单位 MB
`total_flow`	number	设备总流量，单位 MB
`delete_on`	string	当前在用套餐到期时间，可选
`card_slots`	array	卡槽列表

card_slots 字段说明

字段	类型	描述
`slot_code`	string	卡槽编号
`card_no`	string	卡号
`official_real_name_verified`	bool	当前卡槽卡板是否官方实名
`card_status`	int	卡板状态码
`is_main_slot`	bool	是否主卡槽
`is_current_slot`	bool	是否当前在用卡槽

11. 获取设备实名链接 GET /api/v1/device/real-name-url

11. 获取设备实名链接

获取指定设备所有卡槽的官方实名链接列表。

请求信息

项	值
方法	`GET`
路径	`/api/v1/device/real-name-url`
参数格式	Query String

业务参数

参数名	类型	必需	描述	示例
`device_no`	string	是	设备编号	`DEVICE123456789`

请求示例

GET /api/v1/device/real-name-url?device_no=DEVICE123456789&access_key=ak_test123&timestamp=1730619000&nonce=test123&signature=abc123def456
Host: your-domain.com

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": [
    {'{'}
      "slot_code": "1",
      "card_no": "8986001234567890123",
      "official_real_name_verified": false,
      "is_main_slot": true,
      "is_current_slot": true,
      "url": "https://example.com/real-name?device_no=DEVICE123456789&slot=1"
    {'}'},
    {'{'}
      "slot_code": "2",
      "card_no": "8986001234567890124",
      "official_real_name_verified": true,
      "is_main_slot": false,
      "is_current_slot": false,
      "url": ""
    {'}'}
  ],
  "ok": true
{'}'}

data 子字段说明

字段	类型	描述
`slot_code`	string	卡槽编号，按卡槽编号排序返回
`card_no`	string	卡号
`official_real_name_verified`	bool	当前卡槽卡板是否已官方实名
`is_main_slot`	bool	是否主卡槽
`is_current_slot`	bool	是否当前在用卡槽
`url`	string	实名链接；当前卡槽不可实名时为空字符串，已实名仍正常返回链接
`msg`	string	当前卡槽不可实名的原因，可选

业务规则

场景	返回
当前卡槽已官方实名	该卡槽 `official_real_name_verified=true`，仍正常返回 `url`
套餐系列要求先充值后实名，且设备或卡槽没有已支付订单	该卡槽 `url=""`，`msg` 为 `设备需要先充值后实名`
当前设备生效套餐为单网套餐，且该卡槽运营商与当前生效套餐不匹配	该卡槽 `url=""`，`msg` 为 `当前在用单网套餐仅支持实名对应运营商网络`
设备卡板或卡槽配置异常	`InternalError`

说明

单网套餐只允许实名当前生效套餐对应运营商的卡槽；不再按主副卡槽固定限制。
如果卡槽配置为上游实名链接，系统会优先通过设备号获取上游设备实名链接；取不到时回退到卡板实名链接逻辑。
调用方只需要传 device_no，不需要传 slot_code。

12. 设备套餐订购 POST /api/v1/device/orders

12. 设备套餐订购

为指定设备订购套餐。

请求信息

项	值
方法	`POST`
路径	`/api/v1/device/orders`
参数格式	JSON 或 Form

业务参数

参数名	类型	必需	描述	示例
`device_no`	string	是	设备编号	`DEVICE123456789`
`package_code`	string	是	套餐编码	`pkg_d4k9...`
`strategy`	uint8	是	生效策略，`1`=本月生效，`2`=次月生效	`1`

请求示例

{'{'}
  "device_no": "DEVICE123456789",
  "package_code": "pkg_d4k9...",
  "strategy": 1,
  "access_key": "ak_test123",
  "timestamp": "1730619000",
  "nonce": "test123",
  "signature": "abc123def456"
{'}'}

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": {'{'}
    "order_no": "ORD202605030002"
  {'}'},
  "ok": true
{'}'}

业务规则

当前使用余额支付。
余额不足、套餐不可用、设备状态不满足时会返回失败。
strategy=1 表示本月生效，strategy=2 表示次月生效。

13. 设备操作指令 POST /api/v1/device/command

13. 设备操作指令

统一执行设备相关指令。

请求信息

项	值
方法	`POST`
路径	`/api/v1/device/command`
参数格式	JSON 或 Form

基础业务参数

参数名	类型	必需	描述	示例
`device_no`	string	是	设备编号	`DEVICE123456789`
`command`	string	是	指令名称	`restart`

command 明细

command	描述	额外参数
`restart`	设备启用/复机	无
`shutdown`	设备禁用/停机	无
`restart_device`	重启设备	无
`shutdown_device`	设备关机	无
`factory_reset`	恢复出厂设置	无
`switch_network`	切换设备在用卡槽	`slot_code` 必填
`set_wifi_visible`	设置 WiFi 是否隐藏	`hidden` 必填，bool，`true`=隐藏，`false`=显示
`update_wifi`	修改 WiFi 名称和密码	`wifi_name`、`wifi_password` 必填

请求示例：设备复机

{'{'}
  "device_no": "DEVICE123456789",
  "command": "restart",
  "access_key": "ak_test123",
  "timestamp": "1730619000",
  "nonce": "test123",
  "signature": "abc123def456"
{'}'}

请求示例：设备关机

{'{'}
  "device_no": "DEVICE123456789",
  "command": "shutdown_device",
  "access_key": "ak_test123",
  "timestamp": "1730619000",
  "nonce": "test123",
  "signature": "abc123def456"
{'}'}

请求示例：切网

{'{'}
  "device_no": "DEVICE123456789",
  "command": "switch_network",
  "slot_code": "1",
  "access_key": "ak_test123",
  "timestamp": "1730619000",
  "nonce": "test123",
  "signature": "abc123def456"
{'}'}

请求示例：修改 WiFi

{'{'}
  "device_no": "DEVICE123456789",
  "command": "update_wifi",
  "wifi_name": "TCZK-5G",
  "wifi_password": "12345678",
  "access_key": "ak_test123",
  "timestamp": "1730619000",
  "nonce": "test123",
  "signature": "abc123def456"
{'}'}

成功响应

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": true,
  "ok": true
{'}'}

业务规则

restart 是设备启用/复机，shutdown 是设备禁用/停机；restart_device 是设备重启，shutdown_device 是设备关机。
restart、shutdown 需要 API 账号具有停复机权限。
restart_device、shutdown_device、factory_reset、switch_network、set_wifi_visible、update_wifi 需要设备所属平台支持对应能力，不支持时会返回能力不支持错误。
switch_network 的 slot_code 必须存在于设备所属渠道的卡槽配置中。
当前生效套餐为单网套餐时，switch_network 只允许切到该套餐对应的运营商卡槽。
set_wifi_visible 必须传 hidden。
update_wifi 必须同时传 wifi_name 和 wifi_password。

14. 查询代理余额 GET /api/v1/agent/balance

14. 查询代理余额

查询当前 OpenAPI 授权代理的账户余额。

请求信息

项	值
方法	`GET`
路径	`/api/v1/agent/balance`
参数	通用签名参数

请求示例

GET /api/v1/agent/balance?access_key=ak_test123&timestamp=1730619000&nonce=test123&signature=abc123def456
Host: your-domain.com

响应示例

{'{'}
  "code": "OK",
  "msg": "ok",
  "data": {'{'}
    "agent_id": 1,
    "balance": 100.5
  {'}'},
  "ok": true
{'}'}

data 字段说明

字段	类型	描述
`agent_id`	number	当前 OpenAPI 授权代理 ID
`balance`	number	当前代理账户余额，单位元

说明

接口只返回当前 access_key 对应代理的余额，不支持传入代理 ID 查询其他代理。
返回余额为当前账户实时余额。