Guides
Guides
Practical guides for authentication, devices, live sessions, push, and playback with go-ring.
These guides explain the main customer workflows in go-ring. The generated
API reference describes the HTTP and signaling contracts; the guides show how
to use the public Go client around those operations.
Start here
- Authenticate and manage tokens
- Use the diagnostic CLI
- Configure the client and transports
- Discover devices and send controls
- Browse locations and inspect status
- Fetch snapshots and unlock an intercom
- Browse and manage recordings
- Receive account events and request tickets
- Open and manage a live session
- Create an SDP offer and exchange ICE candidates
- Receive FCM and signaling push notifications
- Negotiate cloud playback
The runnable programs in the repository's examples/ directory provide
complete versions of several workflows, including token exchange, device
enumeration, live streaming, PTZ, and signaling push events.
Compatibility
For model import and low-level event changes, see upgrading from v0.6.
Ring's endpoints and message formats can change, and behavior may vary by account, device, and region. Handle unavailable operations and errors in your application.