UBubiquiti
Speaker information & management

Get all speakers

Get detailed information about all speakers

get/v1/speakers

Request

Response

Success response

idstring required

The primary key of speaker

modelKey'speaker' required

The model key of the speaker

state'CONNECTED' | 'CONNECTING' | 'DISCONNECTED' required

Connection state of the device.

namestring required

The name of the device.

macstring required

The primary MAC address of the device.

volumeinteger required

Speaker volume: a number from 0-100.

micVolumeinteger required

Mic volume: a number from 0-100.

isMicEnabledboolean required

Whether or not the microphone on the speaker is enabled.

Example response

[
  {
    "id": "66d025b301ebc903e80003ea",
    "state": "CONNECTED",
    "name": "Front Door",
    "mac": "24A43C3DFEB9",
    "volume": 80,
    "micVolume": 80,
    "isMicEnabled": true,
    "speakerState": {
      "status": "idle",
      "mode": "listen"
    },
    "featureFlags": {
      "hasMic": true
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.