v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Speakers

This endpoint allows you to retrieve a specific speaker.

get/speakers/{speakerId}

Query parameters

includestring[]

Response

OK

idstring required
accountIdstring required
namestring required

User-defined name for the device.

bridgeIdstring required
locationIdstring nullable

ID Of the location.

isSharedboolean
notesstring
tagsstring[]
visibleByBridgesstring[]

Example response

{
  "name": "My new device",
  "bridgeId": "1000f60d",
  "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2",
  "statusV2": {
    "cloudConnectionStatus": "connected",
    "edgeReportedDeviceStatus": "operational",
    "deviceSpecificError": "generalDeviceError"
  },
  "notes": "Painted black to better blend with its environment.",
  "bridgeSummary": {
    "id": "1000f60d",
    "name": "Front Lobby Bridge"
  },
  "timeZone": {
    "zone": "America/Chicago"
  },
  "devicePosition": {
    "latitude": 52.3074013,
    "longitude": 4.9459903,
    "azimuth": 7.419435,
    "rangeInMeters": 50.4,
    "floor": 50,
    "fieldOfView": 100
  },
  "networkInfo": {
    "ipUsedByBridge": "10.143.55.140",
    "adapters": [
      {
        "macAddress": "8A:D4:AD:09:DF:91",
        "ipAddress": "10.143.55.140"
      }
    ]
  },
  "deviceInfo": {
    "make": "Axis communications",
    "model": "C1310-E Network Horn Speaker",
    "guid": "ddfa5b34-5d04-431e-8287-110fe87edf71"
  },
  "visibleByBridges": [
    "1000f60d"
  ],
  "settings": {
    "sipPort": 5060
  }
}