Viewer information & management

Get all viewers

Get detailed information about all viewers

get/v1/viewers

Request

Response

Success response

idstring required

The primary key of viewer

modelKey'viewer' required

The model key of the viewer

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.

liveviewstring required

The primary key of liveview

streamLimitnumber required

Count of maximum supported parallel live streams.

Example response

[
  {
    "id": "66d025b301ebc903e80003ea",
    "state": "CONNECTED",
    "name": "Front Door",
    "mac": "24A43C3DFEB9",
    "liveview": "66d025b301ebc903e80003ea",
    "streamLimit": 1
  }
]

Changes

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