EAeagleeyenetworks
Speakers

GET /speakers/{speakerId}/settings

Retrieves the current settings for the given speaker.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/speakers/{speakerId}/settings
  • Auth
    HTTP bearer

Query parameters

includestring[]

Response

OK

schemaAdvancedSettingsSchema

Json schema of version draft 4.

Example response

{
  "data": {
    "protocol": "sip"
  },
  "schema": {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
      "protocol": {
        "type": "string",
        "enum": [
          "sip",
          "onvif"
        ]
      },
      "audioMode": {
        "type": "string",
        "enum": [
          "disabled",
          "talkDown",
          "twoWayAudio"
        ]
      },
      "mainCredentials": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "password": {
            "type": "string"
          }
        }
      },
      "sipCredentials": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "password": {
            "type": "string"
          }
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.