设备状态管理
本节介绍如何通过接口查询设备列表并控制设备的启用 / 禁用状态。
完整流程分两步:
- 1.调用获取设备列表接口取得设备
id, - 2.调用设置设备状态接口变更目标设备的状态。
调用流程说明
1. 调用 pageForCorp 接口,传入 pageNumber 和 pageSize
↓
2. 从返回的 records 列表中定位目标设备,记录其 id 字段
↓
3. 调用 changeState 接口,传入 id 和目标 state(-1 启用 / 0 禁用)
↓
4. 根据响应 code 判断是否操作成功
注意事项
changeState接口的id必须来源于pageForCorp返回的设备id字段,请勿使用deviceCode或uniqueId替代。state字段仅接受-1(启用)和0(禁用)两个合法值,传入其他值可能返回错误。- 两个接口均需携带合法的鉴权信息,具体鉴权方式请参考接口鉴权说明。
- 授权令牌不是企业管理员时,接口返回“权限不足”。
1. 获取企业设备列表
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | GET |
| 接口路径 | https://yz365.tongueai.com/yz365-b2b2c/seller/tongueDevice/pageForCorp |
| 说明 | 分页查询当前企业下的舌诊设备列表,返回设备基本信息及绑定关系 |
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| pageNumber | Integer | 是 | 页码,从 1 开始 |
| pageSize | Integer | 是 | 每页条数,建议 20 |
请求示例
GET https://yz365.tongueai.com/yz365-b2b2c/seller/tongueDevice/pageForCorp?pageNumber=1&pageSize=20
响应参数
结果格式
格式为 JSON ,响应数据位于 result 中
| 参数 | 类型 | 描述 |
|---|---|---|
code | number | 200 为成功,其他为失败 |
success | boolean | 响应状态,success为成功,其他为失败 |
message | string | 响应结果描述 |
timestamp | number | 时间戳 |
result | array | 响应数据 |
分页对象包含以下记录字段:
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | String | 设备主键 ID,用于后续状态变更接口 |
| deviceCode | String | 设备编码 |
| deviceName | String | 设备名称 |
| boundCorpId | String | 绑定公司 ID |
| boundStoreId | String | 绑定店铺 ID,多个以逗号分隔 |
| boundMemberId | String | 绑定会员 ID |
| boundMemberName | String | 绑定会员名称 |
| uniqueId | String | 设备唯一标识 |
| ipAddress | String | 设备 IP 地址 |
| approximateLocation | String | 大致位置(省-市-区) |
| bindingTime | String | 绑定时间,格式 yyyy-MM-dd HH:mm(GMT+8) |
| offlineStoreId | String | 所属店铺 / 分组 ID |
| groupName | String | 所属店铺 / 分组名称 |
| serialNumber | String | 设备序列号(SN) |
| expirationTime | String | 过期时间,格式 yyyy-MM-dd HH:mm(GMT+8) |
| limitCount | Integer | 限制使用次数,-1 表示不限制 |
| deviceRemark | String | 设备备注 |
响应示例
{
"code": 200,
"success": true,
"message": "success",
"timestamp": 1727233247994,
"data": {
"current": 1,
"size": 20,
"total": 2,
"records": [
{
"id": "1001",
"deviceCode": "TD20240001",
"deviceName": "门店舌诊仪-01",
"boundCorpId": "CORP_001",
"boundStoreId": "STORE_001,STORE_002",
"boundMemberId": "MBR_001",
"boundMemberName": "张三",
"uniqueId": "UNIQUE_ABC123",
"ipAddress": "192.168.1.100",
"approximateLocation": "广东-深圳-南山区",
"bindingTime": "2024-01-15 10:30",
"offlineStoreId": "GRP_001",
"groupName": "南山区门店组",
"serialNumber": "SN20240001",
"expirationTime": "2025-01-15 00:00",
"limitCount": -1,
"deviceRemark": "主门店使用设备"
}
]
}
}
2. 设置设备启用 / 禁用状态
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | GET |
| 接口路径 | https://yz365.tongueai.com/yz365-b2b2c/seller/tongueDevice/changeState |
| 说明 | 根据设备 ID 变更设备的启用或禁用状态 |
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | String | 是 | 设备主键 ID,从设备列表接口返回的 id 字段获取 |
| state | Integer | 是 | 目标状态:-1 = 启用,0 = 禁用 |
请求示例(启用设备)
GET https://yz365.tongueai.com/yz365-b2b2c/seller/tongueDevice/changeState?id=1001&state=-1
请求示例(禁用设备)
GET https://yz365.tongueai.com/yz365-b2b2c/seller/tongueDevice/changeState?id=1001&state=0
响应参数
接口返回统一响应结构:
| 参数 | 类型 | 描述 |
|---|---|---|
code | number | 200 为成功,其他为失败 |
success | boolean | 响应状态,success为成功,其他为失败 |
message | string | 响应结果描述 |
timestamp | number | 时间戳 |
result | array | 响应数据 |
响应示例
{
"code": 200,
"success": true,
"message": "success",
"timestamp": 1727233247994,
"data": null
}
2. 接口变更说明
2026.05.07
设备状态管理接口API上线。
