BOSE PROFESSIONAL
VIDEOBARREST API GUIDE
Version 1.5

Classified as Public

Table of Contents

Introduction .................................................................................................................................................. 2
Trademark Notices ........................................................................................................................................ 2
Privacy Information....................................................................................................................................... 3
Enabling and Configuring the REST API......................................................................................................... 3
Testing the REST API ..................................................................................................................................... 3
REST API Commands ..................................................................................................................................... 3
GET ............................................................................................................................................................ 4
PUT ............................................................................................................................................................ 4
POST .......................................................................................................................................................... 5
DELETE....................................................................................................................................................... 5
Videobar REST API Command Reference...................................................................................................... 6

Bose Professional Videobar REST API Guide
Classified as Public

1

Introduction
Bose Professional Videobar devices support representational state transfer application
programming interface (REST API) for network management and monitoring. This guideprovides instructions for enabling and configuring REST API on Videobar devices, and it
provides a detailed description of the supported variables and operations.
Configuration items and operations are grouped in these categories:
systembehavior
usb
audio
cameraaudioframing
bluetoothnetwork (VB1)
wifi
telemetry (VB1)
The API Command Reference section provides the following information for each object:
Name/Description

Name of the object and description of its use.

Actions

Actions that can be performed on the object. The action canbe one or more of the following: get, put, delete, post.

Range of Values

Acceptable values for the object.

Default ValueDefault value of the object. This is the value that is used if
you revert the device to factory defaults.

All values are specified as strings.

Trademark Notices
Bose is a trademark of Bose Corporation.
Videobar is a trademark of Transom Post OpCo, LLC.
The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc.
and any use of such marks by Bose Professional is under license.
The term HDMI is a trademark or registered trademark of HDMI Licensing Administrator, Inc.
Wi-Fi is a registered trademark of Wi-Fi Alliance®.
All other trademarks are the property of their respective owners.

Bose Professional Videobar REST API Guide
Classified as Public

2Privacy Information
Your privacy is important to Bose Professional so we’ve developed a Privacy Policy thatcovers how we collect, use, disclose, transfer, and store your personal information.
PLEASE READ THIS PRIVACY POLICY CAREFULLY TO UNDERSTAND HOW WE HANDLE
YOUR INFORMATION. IF YOU DO NOT AGREE TO THIS PRIVACY POLICY, PLEASE DO NOTUSE THE SERVICES.

Enabling and Configuring the REST API
To enable access to the REST API on a device, use the Bose Professional Videobar
Configuration app, Videobar Administration app, or the Web UI. Access the Network > API
settings. Enable API access and specify an API username and password. You will need these
API credentials to use any of the REST API commands. Please reference the application user
guides for more information.

Testing the REST API
You can test the Videobar REST API by using the Swagger OpenAPI interface that isembedded in the device. To access this interface the Videobar must be connected to an IPnetwork via its wired or WiFi interface, and your host PC must be on the same network or anetwork that can access the device via HTTPS.
Connect your PC to the Videobar via the USB interface. Start the Videobar Configuration app
and sign in to access admin controls. Choose the Network > API page and click the link:
REST API Documentation (Web UI)
If you are not connected to the device via USB and your PC is on the same network, you canaccess the REST API via your browser by browsing to the following address:
https://<videobar-ip-address>/doc-api

REST API Commands
The Videobar REST API interface uses command IDs in each of the four HTTP methodssupported: get, put, delete, and post.
Below is a description of the four methods followed by a table describing the methods
supported for each of the commands.

Bose Professional Videobar REST API Guide
Classified as Public3

GET
The "get" method accepts a single command ID or multiple comma-delimited IDs.
For example, to get the audio.micMute state, the command ID is 2. The URL is like this:https://192.168.1.40/api?query=2
The response body is as follows, with a value of "0" indicating the mic is not muted:{"2": {"status": "success", "value": "0"}}To query for multiple values, separate multiple command IDs with a comma. For example, you
could query for audio.micMute (ID=2) and system.firmwareVersion (ID=16) like this:https://192.168.1.40/api?query=2,16
Note: Do not include spaces between multiple IDs.
The result would be:{"2": {"status": "success", "value": "0"}, "16": {"status":"success", "value": "1.2.13_fd6cc0e"}}

PUT
A "put" command uses a JSON body format with the key being "data" and the value being
ID:value pairs.
For example, to set the audio.loudspeakerVolume (ID=3) to 39, the "https://192.168.1.40/api"
body is:{"data":"{"3":"39"}"}The response is:{"3": {"status": "success", "code": "0xe000"}}
Here is an example setting multiple values:{"data":"{"2":"1","3":"70"}"}
The response is:{"2": {"status": "success", "code": "0xe000"}, "3": {"status":"success", "code": "0xe000"}}
Response "code" values can be any of the following:

0xe000 : Success0xe001 : Success – No change in value
0xe002 : Error – Invalid property

Bose Professional Videobar REST API GuideClassified as Public4

0xe003 : Error – Invalid property value
0xe004 : Error – Invalid property action
0xe005 : Error – Message malformed
0xe006 : Error – Access denied

POST
A "post" is similar to "put" and is used for actions, such as toggle mic mute and speakervolume up/down. You specify the command ID and use an empty string for the value.
For example, to increase the speaker volume one tick, use audio.loudspeakerVolumeUp(ID=4) with the body format like this:{"data":"{"4":""}"}The response body is:{"4": {"status": "success", "code": "0xe000"}}
The possible response “code” values are the same those listed for the PUT command.

DELETEThe "delete" command format is similar to "get", and the response body is similar to "put".
Using delete will set the value back to its default.
For example, to set the audio.loudspeakerVolume (ID=3) to its default value, the URL is likethis:https://192.168.1.40/api?delete=3
The response body is:{"3": {"status": "success", "code": "0xe000"}}
You would need to issue a "get" to retrieve the new value, which in this case is 50. For
example:Command:https://192.168.1.40/api?query=3
Response:{"3": {"status": "success", "value": "50"}}
The possible response “code” values are the same those listed for the PUT command.

Bose Professional Videobar REST API Guide
Classified as Public5Videobar REST API Command Reference
Name / Description

Actions

Range of Values

Default Value

postCmdID
32

system.reboot

N/AN/Asystem.serialNumber

get10string(17 chars)

000000X00000000XX

system.firmwareVersion

get

16string(1-16 chars)

0.0.0

system.modelget

D6string(1-22 chars)

Not setsystem.nameget
putdelete25

string(1-22 chars)

Not setsystem.room

get
put
deleteget
put
deleteget
put
deleteget

26

string(0-128 chars)

Not set27string(0-128 chars)

Not set28

string(0-128 chars)

Not setC71|0(Supported in VB1)
0system.maxOccupancyget
putdelete

DFstring(0-128 chars)

Not setbehavior.ethernetEnabled (VB1)

getputdelete381|0(Supported in VB1)
1behavior.bluetoothEnabled

3A

1|01

3B

1|01

C91|0

(Supported in VB1)
0usb.connectionStatusget
putdeleteget
put
deleteget
put
delete
get

36

1|00

usb.callStatus

get

37

1|00

audio.micMute

get
put

2

1|00

audio.micMuteToggle

post

15

N/A

N/A

Reboots the system.
Serial number of the device.
Version of the firmware running on
the device. This is set automaticallyon system firmware upgrade.
Model of this device.

Name of the device so it can beuniquely identified.
Room location of the device

system.floorFloor location of the device.

system.building

Building location of the device.

system.gpiMuteStatus (VB1)
GPI mute status (on/off).

Room maximum occupancy of thedevice.
Turns on/off the system Ethernet
interface.
Turns on/off the system Bluetooth.

behavior.wifiEnabled

Turns on/off the system WiFi.

behavior.hdmiEnabled (VB1)
Turns on/off the HDMI.

USB cable connection status; 0 when
disconnected.
Call status from the host connected
to USB port of the system.
Mutes/unmutes the system
microphone.
Toggles the mute state of the system
microphone.

Bose Professional Videobar REST API Guide
Classified as Public

6

Name / Description

Actions

Range of Values

Default Value

post

Cmd
ID
34

audio.loudspeakerMute

N/A

N/A

audio.loudspeakerMuteToggle

post

34

N/A

N/A

audio.loudspeakerVolume

30-10050

audio.loudspeakerVolumeUp

get
put
delete
post

4

N/A

N/A

audio.loudspeakerVolumeDown

post

5

N/A

N/A

camera.zoom

6

1-10

1

7-10-100

8-10-100camera.zoomIn

get
put
deleteget
put
deleteget
put
delete
post

9

N/A

N/A

camera.zoomOut

post

0A

N/A

N/A

camera.panLeft

post

0B

N/A

N/A

camera.panRight

post

0C

N/A

N/A

camera.tiltUp

post

0D

N/A

N/A

camera.tiltDown

post

0E

N/A

N/A

camera.homePresetget
put
delete56<pan><space><tilt><space><zoom>

001

camera.firstPresetget
put
delete57<pan><space><tilt><space><zoom>

001

camera.secondPresetget
put
delete58<pan><space><tilt><space><zoom>

001

camera.savePresetHome

post

12

N/A

N/A

camera.savePresetFirst

post

17

N/A

N/A

camera.savePresetSecond

post

18

N/A

N/A

Mutes/unmutes the system
loudspeaker.

Toggles the mute state of the system
loudspeaker.
Sets the system loudspeaker volume.
Increases the system loudspeakervolume by one step.
Decreases the system loudspeakervolume by one step.
The camera’s current zoom value.

camera.pan

The camera’s current pan value.

camera.tilt

The camera’s current tilt value.
Zooms camera in by one step.
Zooms camera out by one step.
Pans camera left by one step.
Pans camera right by one step.
Tilts camera up by one step.
Tilts camera down by one step.
Camera home preset in pan tilt zoomorder
Camera first preset in pan tilt zoomorder.
Camera second preset in pan tilt
zoom order.
Saves to the home preset the current
PTZ values.

Saves to the first preset the current
PTZ values.
Saves to the second preset thecurrent PTZ values.

Bose Professional Videobar REST API Guide
Classified as Public

7Name / Description

Actions

Cmd
ID
0F

Range of Values

Default Value

camera.applyActivePreset

post

N/A

N/A

camera.activePresetget
put
delete

13

1|2|3

1

camera.state

get

60

active|inactive|
upgradinginactive

autoframing.stateget
putdelete191|00

bluetooth.pairingStateToggle

post

C6

N/A

N/A

bluetooth.pairingState

get
put

141|00

bluetooth.state

get

67

1|00

bluetooth.paired

get

6A

string(0-128 chars)

Not setbluetooth.connected

get

6B

1|00

bluetooth.streamState

get

C2

1|00

bluetooth.callState

get

6C

1|00

bluetooth.disconnect

post

E4

1|2|3

N/A

network.dhcpStateget
putdelete74

1|01

network.ip (VB1)get
putdelete75

network.state (VB1)

get

7F

Applies the active preset to the PTZ
settings.
This is the active preset. Note, atcamera start or restart the active
preset is set to Home.

Camera state. When active, camera isstreaming video. When inactive,camera is not streaming. Whenupgrading, camera is upgrading
firmware.
Turn on/off the camera autoframing
feature.
Toggle the pairing state from on/off
to off/on.
Bluetooth pairing state. The on state
will allow pairing with the device for a
fixed interval. Once the pairing
interval is over, the state will change
to off.
Bluetooth and BLE state. The on state
will indicate that Bluetooth and BLE
are on; the off state will indicate thatthe Bluetooth and BLE are off.
Paired device name.
Paired device connection status.
Stream status of Bluetooth.
Status of Bluetooth call.
Disconnect Bluetooth device.
DHCP state. When DHCP state is on,
network will be configured through
DHCP. When DHCP state is off, staticvalues are used.
Static IP address when DHCP state isoff.
State of the Ethernet module.

(Supported in VB1)
0.0.0.0
idle|
failure|association|
configuration|
ready|
disconnect|
onlineBose Professional Videobar REST API Guide
Classified as Public(Supported in VB1)
ready8Name / DescriptionActionsCmdID
80

Range of Values

network.mac (VB1)

getwifi.dhcpStateget
putdeleteA1

1|0wifi.ipget
put
deleteA2

0.0.0.0

wifi.macget

AC

00:00:00:00:00:00

wifi.state

get

B0

telemetry.peopleCount (VB1)get
putdeletetelemetry.peoplePresent (VB1)get
putdelete

MAC address of the LAN interface.
DHCP state. When DHCP state is on,
WiFi will be configured through
DHCP. When DHCP state is off, staticvalues are used.
Static IP address when DHCP state isoff.
MAC address of the WiFi interface.
State of the WiFi module.

The number of people counted by thecamera autoframing algorithm.
True when any people have been
detected by the camera autoframingalgorithm.

(Supported in VB1)
00:00:00:00:00:00
1

idle

DA

idle|
failure|association|
configuration|
ready|
disconnect|
online
0-99

DC

1|0

(Supported in VB1)
0

Bose Professional Videobar REST API Guide
Classified as Public

Default Value(Supported in VB1)
09

©2023 Transom Post OpCo, LLC. Framingham, MA 01701 USA. Rev. 03

Bose Professional Videobar REST API Guide
Classified as Public

10