WebSocket 使用范围
本文档说明当前 WebSocket 的可用范围,包含已发布的连接端点、主题和使用规则。WebSocket 用于提供实时能力,包括连接保活、状态查询和设备事件接收。
当前发布范围
当前包含以下连接和主题:
text
POST /wlte/v1/ws/ticket
GET /wlte/v1/ws?ticket={ticket}
session.ping
device.status.get
device.operation.execute
device.connection.online
device.connection.offline
device.state.changed
device.power.lost当前使用规则
- 建立连接前必须先创建一次性
wsTicket wsTicket只能使用一次- WebSocket session 不得超过创建 ticket 时所使用 access token 的过期时间
- 所有 WebSocket 文本消息都使用 JSON
request和reply通过requestId关联event通过topic区分事件类型- 客户端必须基于
error.code做错误分支 error.message仅用于展示、日志和排障- 设备外设状态数据复用 REST Device 结构中的
peripherals、status、stateUpdatedAt
当前不包含
- 历史事件回放
- Webhook
- 批量控制
- 设备组控制
- OTA
- 调度设置
- 复杂订阅规则
