WebSocket Coverage

This page describes the current WebSocket coverage, including the published endpoints, topics, and usage rules. WebSocket is used for real-time capabilities such as connection keepalive, status queries, and device event delivery.

Current Coverage

The current version includes these endpoints and topics:

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

Current Rules

• Create a one-time wsTicket before establishing the connection
• A wsTicket can only be used once
• A WebSocket session cannot outlive the access token that was used to create the ticket
• All WebSocket text messages use JSON
• request and reply are matched by requestId
• event messages are distinguished by topic
• Clients must branch on error.code
• error.message is only for display, logs, and troubleshooting
• Device peripheral state data reuses peripherals, status, and stateUpdatedAt from the REST Device schema

Not Included Yet

• Historical event replay
• Webhooks
• Batch control
• Device group control
• OTA
• Scheduling configuration
• Complex subscription rules

Continue Reading

• Create WebSocket Ticket
• Establish Connection
• Message Format
• Rate Limits and Retries