Endpoint reference
Every endpoint a QuickComm device calls or expects, by mode, with the method, path and purpose — the complete surface your server implements.
4 min read
On this page
This is the complete device-facing surface. A device calls only what its mode needs, and everything outside the fleet plane degrades gracefully if you return 404 — so you can implement this list top-down and have a working integration before you reach the bottom of it.
The fleet plane — every mode
| Method | Path | Purpose |
|---|---|---|
| POST | /api/devices/heartbeat | Presence and telemetry. Every 30 s. The one mandatory endpoint |
| POST | /api/devices/register | Self-registration. Idempotent |
| POST | /api/auth/device/token | A bearer credential for the device's own calls |
| POST | /api/devices/{mac}/incident | Self-reported fault |
| GET | /api/devices/{mac}/commands/pending | Poll for commands. Marks them sent |
| PATCH | /api/devices/{mac}/commands/{id}/ack | Acknowledge receipt |
| PATCH | /api/devices/{mac}/commands/{id}/result | COMPLETED or FAILED |
| GET | /api/devices/{mac}/ota/check | Firmware availability |
| PATCH | /api/devices/{mac}/ota/{id}/progress | DOWNLOADING, INSTALLING, SUCCESS, FAILED, ROLLED_BACK |
| GET | /health | Liveness |
Mode A — push-to-talk streaming
| Transport | Endpoint | Purpose |
|---|---|---|
| UDP | udp://<host>:12345 | udp-v1 audio ingest. One datagram per capture buffer |
Mode B — request and response
| Method | Path | Purpose |
|---|---|---|
| POST | /voice | Framed PCM uplink. Returns the literal string ok |
| POST | /voiceecho | Framed PCM in, WAV plus transcript headers out. Bring-up only |
| GET | /sse/notifications | Downlink audio queue. 204 when empty |
| GET | /voice/test | Fixture: framed silence, for playback bring-up |
Mode C — full-duplex agent
| Transport | Endpoint | Purpose |
|---|---|---|
| WSS | wss://<host>/ws | Conversational agent. PCM both ways, JSON control frames |
| GET | /restaurant/print-jobs | Claim a print job. 204 when empty |
| POST | /restaurant/orders/{id}/printed | Mandatory acknowledgement |
| POST | /restaurant/orders | Create an order |
| GET | /restaurant/menu | Catalogue for a site |
Something wrong or missing on this page? Tell us.