/speakers/{speakerId}

get https://{BaseUrl}/api/v3.0/speakers/{speakerId}

This endpoint allows you to retrieve a specific speaker.

Responses

Response body

object

string

required

accountId

string

required

name

string

required

length between 1 and 126

User-defined name for the device.

bridgeId

string

required

locationId

string | null

ID Of the location.

isShared

boolean

status

object

Indicates various aspects of the device's status. The statuses defined here should be in sync with the events schema defined for the Device Cloud Status Update.

connectionStatus

string

Indicates the connection status of the device:

online: The device is online and operational.
deviceOffline: The device is offline.
invalidCredentials: The known credentials for this device, including default credentials for this model,
are not valid, resulting in the device being offline.
bridgeOffline: The bridge that connects to the device itself has no connection with the cloud.
The device itself could still be operational if the bridge is working, but the cloud has no information on
its status.
off: The device is online, but has been turned off by the user.
error: The device is offline due to some problem that has not been described by any of the other statuses.
unknown: The device state is unknown for some reason.

online deviceOffline invalidCredentials bridgeOffline off error unknown

notes

string

length ≤ 5000

tags

locationSummary

object

Summary of location information.

string

name

string

address

object

timeZone

object

zone

string

The timezone the device is in.

devicePosition

object

latitude

double | null

-90 to 90

The latitude of the device. (WGS 84)

longitude

double | null

-180 to 180

The longitude of the device. (WGS 84).

azimuth

double | null

0 to 360

rangeInMeters

double | null

≥ 0

floor

integer | null

-30 to 300

fieldOfView

double | null

0 to 360

Field of view is the range of the observable world visible at any given time through camera viewfinder.

networkInfo

object

interface

string

The bridge interface to which the speaker is attached:

lan: Camera lan interface.
wan: Wide Area network interface.

lan wan

ipUsedByBridge

string | null

The current IP address the bridge is using, in IPv4 or IPv6 format.

adapters

array of objects

adapters

object

macAddress

string | null

ipAddress

string | null

deviceInfo

object

Information that could also be visible on the physical device.

make

string

The Manufactorer or brand of the speaker.

model

string

The model of the speaker.

guid

uuid

visibleByBridges

array of strings

visibleByBridges

settings

object

Device specific settings that can be configured on the speakers. This is accessible for shared speakers?

mainCredentials

object

The credentials that will used for communicating with the devices with the main API of the device, which generally is its ONVIF API.

adminCredentials

object

Credentials that can be shared with end users to allow them to access the camera API through the tunnel functionality to allow them to manually apply certain advanced configurations.

sipCredentials

object

The credentials that will be used to authenticate SIP sessions.

sipPort

integer

1025 to 65535

Defaults to 5060

Port to which SIP requests should be sent from the bridge. Applicable for sip speakers and defaults to 5060

effectivePermissions

object

read

boolean

delete

boolean

edit

boolean

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.cxxx.eagleeyenetworks.com/api/v3.0/speakers/speakerId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

500Something went wrong in the server. Please try again.