Skip to content

WebSocket API ​

WebSocket API 用于接收设备事件、刷新单个设备状态,以及在同一长连接上执行设备操作。

适合使用 WebSocket ​

  • 持续感知设备上线、离线、断电、上电和外设状态变化
  • 用户主动刷新单个设备的实时状态
  • 在已有长连接中控制继电器或执行 RS485 操作
  • 减少高频 HTTP 状态轮询

设备列表、分页查询、设备配置读取和命令结果查询仍使用 REST API。详细选型参见 REST API 与 WebSocket。

接入步骤 ​

  1. 使用 access token 调用 POST /wlte/v1/ws/ticket。
  2. 使用一次性 ticket 连接 GET /wlte/v1/ws?ticket={ticket}。
  3. 启动 Ping/Pong 和 session.ping。
  4. 监听设备事件。
  5. 使用 device.state.get 查询单个设备状态。
  6. 使用 device.operation.execute 执行设备操作。

核心规则 ​

  • request 和 reply 通过 requestId 关联。
  • 设备写操作通过 operation.name 区分。
  • 回复使用 code、message 和可选 data,与 REST 响应语义一致。
  • 事件没有历史回放;断线重连后应查询关键设备状态。
  • 配置变化不广播。当前点动时长和 RS485 波特率通过 REST 查询设备配置。

从 WebSocket 使用范围 查看当前支持的主题和操作。

Docs buildVersion v1.6.2-20260922-134655-89
Copyright © 2026 WLTE