AXIS Audio Manager Edge API

With AXIS Audio Manager Edge API, you can integrate external tools to the AXIS Audio Manager Edge solution.

Targets

A target can be a physical zone or a physical device managed by AXIS Audio Manager Edge. You can use the endpoints to get information of the targets, such as the current status of a device in the site.

info

The target object is an enum that can be extended with additional variants. To be compatible with later versions, the client must ignore the unknown variants.

List targets

Retrieves all targets managed by AXIS Audio Manager Edge.

Request

Method: GET
Content-Type: application/json

https://<servername>/vapix/aam-edge/api/v1.0/targets

Successful response

HTTP Code: 200 Operation successful
Content-Type: application/json

Response example

[
  {
    "type": "device",
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "niceName": "AXIS C0000 - ACCC8E000000",
    "status": {
      "type": "ok"
    }
  }
]

Parameters when the type is device

Parameter	Data type	Description
`type`	string	The type of the target `device`
`id`	string	A unique ID of the device.
`niceName`	string or null	The nice name of the device.
`status`	object	The status of the device.
`type`	string	The status type. Valid values: `error`, `warning`, `pending`, `ok`

Parameters when the type is physicalZone

Parameter	Data type	Description
`type`	string	The type of the target `physicalZone`
`id`	string	A unique ID of the physical zone.
`niceName`	string or null	The nice name of the physical zone.
`children`	array	A list of devices that are contained in the zone.
`type`	string	The type of the target. Valid values: `device`, `physicalZone`. It may be extended with other values in the future.
`id`	string	A unique ID of the target.

Retrieve a target

Retrieves the detailed information of a specified target.

Request

Method: GET
Content-Type: application/json

https://<servername>/vapix/aam-edge/api/v1.0/targets/{targetId}

Path parameter	Data type	Description
`targetId`	string	A unique target ID.

Successful response

HTTP Code: 200 Operation successful
Content-Type: application/json

Response example

{
  "type": "device",
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "niceName": "AXIS C0000 - ACCC8E000000",
  "status": {
    "type": ok
  }
}

Parameters when the type is device

Parameter	Data type	Description
`type`	string	The type of the target `device`
`id`	string	A unique ID of the device.
`niceName`	string or null	The nice name of the device.
`status`	object	The status of the device.
`type`	string	The status type. Valid values: `error`, `warning`, `pending`, `ok`

Parameters when the type is physicalZone

Parameter	Data type	Description
`type`	string	The type of the target `physicalZone`
`id`	string	A unique ID of the physical zone.
`niceName`	string or null	The nice name of the physical zone.
`children`	array	A list of devices that are contained in the zone.
`type`	string	The type of the target. Valid values: `device`, `physicalZone`
`id`	string	A unique ID of the target.

Error response

HTTP Code: 404 Not found
Content-Type: application/json

Response example

{
  "error": {
    "code": 404,
    "message": "string",
    "errors": [
      {
        "reason": "ResourceInstanceNotFound",
        "message": "string",
        "errors": [
          { }
        ]
      }
    ]
  }
}

Parameter	Data type	Description
`error`	object	Container for the error data.
`code`	integer	The error code.
`message`	string	Description of the error.
`errors`	array	Container for detailed error information. Each element in the array represents a different error and several errors can be returned with a single request.
`reason`	string	Unique identifier for this error. Valid values: `ResourceInstanceNotFound`. It may be extended with other reasons in the future.
`message`	string	Detailed description of the error.
`errors`	array	Array of sub errors.

Examples

Example 1 shows how to fetch all targets managed by AXIS Audio Manager Edge. The response shows:

the status of the devices in the site
the information of the devices included in the zone

JSON request:

GET /vapix/aam-edge/api/v1.0/targets

JSON response:

[
  {
    "type": "device",
    "id": "5109a18b-1f48-40d8-b185-586d152fa0e7",
    "niceName": "AXIS C8210 - 00408C1865FF",
    "status": {
      "type": "ok"
    }
  },
  {
    "type": "device",
    "id": "c9820c2a-08c8-4957-8bb4-db67957fad75",
    "niceName": "AXIS C1110 - B8A44F4DFD23",
    "status": {
      "type": "warning"
    }
  },
  {
    "type": "physicalZone",
    "id": "1b5c939d-c622-423d-a297-d6b8925e785d",
    "niceName": "5th floor",
    "children": [
      {
        "type": "device",
        "id": "5109a18b-1f48-40d8-b185-586d152fa0e7"
      }
    ]
  }
]

Example 2 shows how to use targetId to fetch a specific target managed by AXIS Audio Manager Edge. The response shows the device status.

JSON request:

GET /vapix/aam-edge/api/v1.0/targets/fd25b527-b36a-4473-90fc-273810671d25

JSON response:

{
  "type": "device",
  "id": "fd25b527-b36a-4473-90fc-273810671d25",
  "niceName": "AXIS C8210 - B8A44F4DFD12",
  "status": {
    "type": "error"
  }
}

Volume controllers

Use this endpoint to set different volumes for different content type based on zones within the site.

List volume controllers

Retrieves all volume controllers managed by AXIS Audio Manager Edge.

Request

Method: GET
Content-Type: application/json

https://<servername>/vapix/aam-edge/api/v1.1/volumeControllers

Successful response

HTTP Code: 200 Operation successful
Content-Type: application/json

Response example

[
  {
    "allowMute": true,
    "contentClasses": [
      {
        "type": "music"
      }
    ],
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0864",
    "maxVolume": 100,
    "minVolume": 0,
    "muted": true,
    "target": [
      {
        "type": "device",
        "id": "d290f1ee-6c54-4b11-90e6-d701748f0864"
      }
    ],
    "volume": 62
  }
]

Parameter	Data type	Description
`allowMute`	boolean	Shows whether the volume controller can be muted.
`contentClasses`	array	Contains the target content classes. `type`: Valid values: `music`, `paging`, `announcements`, `advertisements`.
`id`	string	The id of volume controller.
`maxVolume`	number	The maximum volume.
`minVolume`	number	The minimum volume.
`muted`	boolean	Shows whether the volume controller is muted.
`target`	array	The targets of the volume controller. `type`: Valid values: `device`, `physicalZone`. `id`: The id of the target.
`volume`	number	The volume value for the specified content type of all targets associated with the volume controller. Valid value is between the maximum volume and minimum volume.

Retrieve a volume controller

Retrieves the detailed information of a specified volume controller.

Request

Method: GET
Content-Type: application/json

https://<servername>/vapix/aam-edge/api/v1.1/volumeControllers/{volumeControllerId}

Path parameter	Data type	Description
`volumeControllerId`	string	The unique ID of the volume controller.

Successful response

HTTP Code: 200 Operation successful
Content-Type: application/json

Response example

{
  "allowMute": true,
  "contentClasses": [
    {
      "type": "music"
    }
  ],
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0864",
  "maxVolume": 100,
  "minVolume": 0,
  "muted": true,
  "target": [
    {
      "type": "device",
      "id": "d290f1ee-6c54-4b11-90e6-d701748f0864"
    }
  ],
  "volume": 62
}

Parameter	Data type	Description
`allowMute`	boolean	Shows whether the volume controller can be muted.
`contentClasses`	array	Contains the target content classes. `type`: Valid values: `music`, `paging`, `announcements`, `advertisements`.
`id`	string	The id of volume controller.
`maxVolume`	number	The maximum volume.
`minVolume`	number	The minimum volume.
`muted`	boolean	Shows whether the volume controller is muted.
`target`	array	The targets of the volume controller. `type`: Valid values: `device`, `physicalZone`. `id`: The id of the target.
`volume`	number	The volume value for the specified content type of all targets associated with the volume controller. Valid value is between the maximum volume and minimum volume.

Error response

HTTP Code: 404 Not found
Content-Type: application/json

Response example

{
  "error": {
    "code": 404,
    "message": "string",
    "errors": [
      {
        "reason": "ResourceInstanceNotFound",
        "message": "string",
        "errors": [
          {}
        ]
      }
    ]
  }
}

Parameter	Data type	Description
`error`	object	Container for the error data.
`code`	integer	The error code.
`message`	string	Description of the error.
`errors`	array	Container for detailed error information. Each element in the array represents a different error and several errors can be returned with a single request.
`reason`	string	Unique identifier for this error. Valid values: `ResourceInstanceNotFound`. It may be extended with other reasons in the future.
`message`	string	Detailed description of the error.
`errors`	array	Array of sub errors.

Modify volume controller

Request

Method: PATCH
Content-Type: application/json

https://<servername>/vapix/aam-edge/api/v1.1/volumeControllers/{volumeControllerId}

Path parameter	Data type	Description
`volumeControllerId`	string	The unique ID of the volume controller.

Request body example

{
  "volume": 50,
  "muted": true
}

Parameter	Data type	Description
`volume`	number	The volume value for the specified content type of all targets associated with the volume controller. Valid value is between the maximum volume and minimum volume.
`muted`	boolean	Shows whether the volume controller is muted.

Successful response

HTTP Code: 200 Operation successful
Content-Type: application/json

Response example

{
  "allowMute": true,
  "contentClasses": [
    {
      "type": "music"
    }
  ],
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0864",
  "maxVolume": 100,
  "minVolume": 0,
  "muted": true,
  "target": [
    {
      "type": "device",
      "id": "d290f1ee-6c54-4b11-90e6-d701748f0864"
    }
  ],
  "volume": 62
}

Parameter	Data type	Description
`allowMute`	boolean	Shows whether the volume controller can be muted.
`contentClasses`	array	Contains the target content classes. `type`: Valid values: `music`, `paging`, `announcements`, `advertisements`.
`id`	string	The id of volume controller.
`maxVolume`	number	The maximum volume.
`minVolume`	number	The minimum volume.
`muted`	boolean	Shows whether the volume controller is muted.
`target`	array	The targets of the volume controller. `type`: Valid values: `device`, `physicalZone`. `id`: The id of the target.
`volume`	number	The volume value for the specified content type of all targets associated with the volume controller. Valid value is between the maximum volume and minimum volume.

Error response 400

HTTP Code: 400 Bad Request
Content-Type: application/json

Response example

{
  "error": {
    "code": 400,
    "message": "string",
    "errors": [
      {
        "reason": "ResourceInstanceNotFound",
        "message": "string",
        "errors": [
          {}
        ]
      }
    ]
  }
}

Parameter	Data type	Description
`error`	object	Container for the error data.
`code`	integer	The error code.
`message`	string	Description of the error.
`errors`	array	Container for detailed error information. Each element in the array represents a different error and several errors can be returned with a single request.
`reason`	string	Unique identifier for this error. Valid values: `ResourceInstanceNotFound`. It may be extended with other reasons in the future.
`message`	string	Detailed description of the error.
`errors`	array	Array of sub errors.

Error response 415

HTTP Code: 415 Payload format is not application/json
Content-Type: application/json

Response example

{
  "error": {
    "code": 415,
    "message": "string",
    "errors": [
      {
        "reason": "ResourceInstanceNotFound",
        "message": "string",
        "errors": [
          {}
        ]
      }
    ]
  }
}

Parameter	Data type	Description
`error`	object	Container for the error data.
`code`	integer	The error code.
`message`	string	Description of the error.
`errors`	array	Container for detailed error information. Each element in the array represents a different error and several errors can be returned with a single request.
`reason`	string	Unique identifier for this error. Valid values: `ResourceInstanceNotFound`. It may be extended with other reasons in the future.
`message`	string	Detailed description of the error.
`errors`	array	Array of sub errors.

Examples

Example 1 shows how to fetch all volume controllers managed by AXIS Audio Manager Edge.

Request example:

GET /vapix/aam-edge/api/v1.1/volumeControllers

Response example:

[
    {
        "allowMute": true,
        "contentClasses":
        [
            "music"
        ],
        "id": "fc058559-7fa1-4b4b-a06d-712dcf8a8791",
        "maxVolume": 100.0,
        "minVolume": 0.0,
        "muted": false,
        "targets":
        [
            {
                "type": "physicalZone",
                "id": "88dd3c6c-bca2-4fde-b2e1-3bf5521697d1"
            }
        ],
        "volume": 39.0
    },
    {
        "allowMute": true,
        "contentClasses":
        [
            "music"
        ],
        "id": "439efad0-133d-4e55-a67b-a78c1da76ad3",
        "maxVolume": 100.0,
        "minVolume": 0.0,
        "muted": false,
        "targets":
        [
            {
                "type": "physicalZone",
                "id": "10791ec1-b01d-46d9-8983-4d27cbad82bb"
            }
        ],
        "volume": 20.0
    },
    {
        "allowMute": false,
        "contentClasses":
        [
            "advertisements"
        ],
        "id": "44182ec9-92b3-43f6-a2c0-e7e6d40c1649",
        "maxVolume": 100.0,
        "minVolume": 0.0,
        "muted": false,
        "targets":
        [
            {
                "type": "physicalZone",
                "id": "88dd3c6c-bca2-4fde-b2e1-3bf5521697d1"
            }
        ],
        "volume": 20.0
    }
]

Example 2 shows how to use a unique ID to fetch a specific volume controller managed by AXIS Audio Manager Edge.

Request example:

GET /vapix/aam-edge/api/v1.1/volumeControllers/fc058559-7fa1-4b4b-a06d-712dcf8a8791

Response example:

{
    "allowMute": true,
    "contentClasses":
    [
        "music"
    ],
    "id": "fc058559-7fa1-4b4b-a06d-712dcf8a8791",
    "maxVolume": 100.0,
    "minVolume": 0.0,
    "muted": false,
    "targets":
    [
        {
            "type": "physicalZone",
            "id": "88dd3c6c-bca2-4fde-b2e1-3bf5521697d1"
        }
    ],
    "volume": 39.0
}

Example 3 shows how to update volume and unmute a specific volume controller.

Request example:

PATCH /vapix/aam-edge/api/v1.1/volumeControllers/fc058559-7fa1-4b4b-a06d-712dcf8a8791

{
    "muted": false,
    "volume": 39.0
}

Targets​

List targets​

Retrieve a target​

Examples​

Volume controllers​

List volume controllers​

Retrieve a volume controller​

Modify volume controller​

Examples​

Targets

List targets

Retrieve a target

Examples

Volume controllers

List volume controllers

Retrieve a volume controller

Modify volume controller

Examples