This outlines the API created to allow third-party companies to query some device information, allow volume control, and subscribe for device status changes.
Encryption: None, clear string text as described.
Transmission Protocol: UDP
This feature allows push notifications from a device to reach a third-party controller. It sets the IP of the controller, subscribing it to that device’s notifications and status changes.
Important: Devices need to be subscribed individually. Only one third-party controller can be set and subscribed to a specific device.
Set Third-Party Controller IP
Statuses pushed to the IP once set
Mute Status Changes
These commands get/set the device's mute status. Status: 0 is unmuted, 1 is muted.
These commands get/set the device's volume. If the USB is plugged into a computer, these commands increment the volume up/down. Volume level ranges 0 to 100.
This provides the status of a device in a room. It is used to make sure all units are still online and connected.
[status]: “0” - not all devices are connected in a room. “1” - everything is connected and working.
This provides the name of the room the device is currently in.
[roomname]: “-1” - Device does not belong to a room, otherwise it will provide the string of the room name.
This provides the call status of the device or the room.
[status]: “0” - not in a call. “1” - in a call.
Device Serial This provides the device's serial number.
[serial]: “0” - no serial number set, otherwise provides the string of the serial number.