BOSE Work Rest API 应用程序用户指南

要在设备上启用对 REST API 的访问，请使用 Bose Work Configuration 应用程序、Bose Work Management 应用程序或 Web 用户界面。访问网络> API 设置。启用 API 访问并指定 API 用户名和密码。您将需要这些 API 凭据才能使用任何 REST API 命令。请参考应用程序用户指南以获取更多信息。

测试 REST API

您可以使用设备中嵌入的 Swagger OpenAPI 接口来测试 Videobar REST API。要访问此接口，Videobar 必须通过其有线或 WiFi 接口连接到 IP 网络，并且您的主机 PC 必须位于同一网络或可以通过 HTTPS 访问设备的网络上。
通过 USB 接口将您的 PC 连接到 Videobar。启动 Bose Work Configuration 应用程序并登录以访问管理控件。选择 Network > API 页面并单击链接：
REST API 文档 (Web 用户界面）
如果您没有通过 USB 连接到设备并且您的 PC 在同一网络上，您可以通过浏览器访问以下地址来访问 REST API：
https://<videobar-ip-address>/doc-api

REST API 命令

Videobar REST API 接口在支持的四种 HTTP 方法中的每一种中使用命令 ID：get、put、delete 和 post。
下面是对四种方法的描述，后面是描述每个命令支持的方法的表格。

得到

“get”方法接受单个命令 ID 或多个以逗号分隔的 ID。例如ample，要获取 audio.micMute 状态，命令 ID 为 2。 URL 就像这样：
https://192.168.1.40/api?query=2

响应正文如下，值为“O”表示麦克风未静音：
{“2”：{“状态”：“成功”，“价值”：“0”}}

要查询多个值，请用逗号分隔多个命令 ID。例如ample，您可以像这样查询 audio.micMute (ID=2) 和 system.firmwareVersion (ID=l6)：
https://192.168.1.40/api?query=2,16

注意：不要在多个 ID 之间包含空格。
结果将是：
{“2”：{“状态”：“成功”，“价值”：“0”}，“16”：{“状态”：“成功”，“价值”：“1.2.13_fd6cc0e”}}

放

“put”命令使用 JSON 正文格式，键是“数据”，值是 ID：值对。
例如ample，将audio.loudspeakerVolume（ID=3）设置为39，“https://192.168.1.40/api”主体为：
{“数据”:”{“3″:”39″}”}

响应为：
{“3”：{“状态”：“成功”，“代码”：“0xe000”}}

这是一个前任ample 设置多个值：
{“数据”:”{“2″:”1″,”3″:”70″}”}

响应为：
{“2”：{“状态”：“成功”，“代码”：“0xe000”}，“3”：{“状态”：“成功”，“代码”：“0xe000”}}

响应“代码”值可以是以下任何一种：

0xe000：成功
0xe001 : 成功 – 值没有变化
0xe002 : 错误 - 无效的属性
0xe003 : 错误 - 无效的属性值
0xe004 : 错误 – 无效的属性操作
0xe005 : 错误 – 消息格式错误
0xe006 : 错误 - 访问被拒绝

邮政

“post”与“put”类似，用于执行操作，例如切换麦克风静音和调高/调低扬声器音量。您指定命令 ID 并使用空字符串作为值。
例如ample，要将扬声器音量提高一格，请使用 audio.loudspeakerVolumeUp (ID=4) 的正文格式，如下所示：
{“数据”：”{“4″：”}”}

响应正文是：
{“4”：{“状态”：“成功”，“代码”：“0xe000”}}
可能的响应“代码”值与为 PUT 命令列出的值相同。

删除

“delete”命令格式类似于“get”，响应体类似于“put”。使用 delete 会将值设置回其默认值。
例如ample，要将 audio.loudspeaker 音量 (ID=3) 设置为其默认值， URL 就像这样：
https://192.168.1.40/api?delete=3

响应正文是：
{“3”：{“状态”：“成功”，“代码”：“0xe000”}}

您需要发出“get”来检索新值，在本例中为 50。例如amp乐：
命令：
https://192.168.1.40/api?query=3

回复：
{“3”：{“状态”：“成功”，“价值”：“50”}}
可能的响应“代码”值与为 PUT 命令列出的值相同

Videobar REST API 命令参考

名称/描述	操作	命令 ID	值的范围	默认值
系统重启重新启动系统。	邮政	32	不适用	不适用
系统.序列号设备的序列号。	得到	10	细绳 (17 个字符)	喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔喔
系统固件版本设备上运行的固件版本。这是在系统固件升级时自动设置的。	得到	16	细绳（1-16 个字符）	0.0.0
系统模型此设备的型号。	得到	D6	细绳（1-22 个字符）	没有设置
系统名称设备的名称，以便可以唯一标识。	得到 put 删除	25	细绳（1-22 个字符）	没有设置
系统房间设备的房间位置	得到 put 删除	26	细绳（0-128 个字符）	没有设置
系统地板设备的地板位置。	得到 put 删除	27	细绳（0-128 个字符）	没有设置
系统构建设备的构建位置。	得到 put 删除	28	细绳（0-128 个字符）	没有设置
system.gpi静音状态 (VBXNUMX) GPI 静音状态（开/关）。	得到	C7	110	（在 VBl 中支持） 0
系统.maxOccupancy 房间内设备的最大入住人数。	得到 put 删除	DF	细绳（0-128 个字符）	没有设置
行为.ethernetEnabled (VBl) 打开/关闭系统以太网接口。	得到 put 删除	38	110	（在 VBl 中支持） 1
行为.bluetoothEnabled 打开/关闭系统蓝牙。	得到 put 删除	3A	110	1
行为.wifi启用打开/关闭系统 WiFi。	得到 put 删除	3B	110	1
行为.hdmiEnabled (VBl) 打开/关闭 HDMI。	得到 put 删除	C9	110	（在 VBl 中支持） 0
usb.connectionStatus USB线连接状态；断开连接时为 0。	得到	36	110	0
usb.callStatus 来自连接到系统 USB 端口的主机的呼叫状态。	得到	37	110	0
音频.micMute 使系统麦克风静音/取消静音。	放上去	2	110	0
音频.micMuteToggle 切换系统麦克风的静音状态。	邮政	15	不适用	不适用

名称/描述	操作	命令 ID	值的范围	默认值
audio.loudspeaker静音使系统扬声器静音/取消静音。	邮政	34	不适用	不适用
音频.loudspeakerMuteToggle 切换系统扬声器的静音状态。	邮政	34	不适用	不适用
音频.扬声器音量设置系统扬声器音量。	得到 put 删除	3	0-100	50
音频.loudspeakerVolumeUp 将系统扬声器音量提高一级。	邮政	4	不适用	不适用
音频.loudspeakerVolumeDown 将系统扬声器音量降低一级。	邮政	5	不适用	不适用
相机.zoom 相机的当前缩放值。	得到 put 删除	6	1-10	1
相机.pan 相机的当前平移值。	得到 put 删除	7	-10-10	0
相机倾斜相机的当前倾斜值。	得到 put 删除	8	-10-10	0
相机.放大一步放大相机。	邮政	9	不适用	不适用
相机.zoomOut 将相机缩小一级。	邮政	OA	不适用	不适用
相机.pan 左边将相机向左平移一步。	邮政	OB	不适用	不适用
相机.pan 正确的将相机向右平移一步。	邮政	oc	不适用	不适用
相机.tiltUp 将相机向上倾斜一级。	邮政	OD	不适用	不适用
相机.tiltDown 将相机向下倾斜一步。	邮政	OE	不适用	不适用
camera.home预设以平移倾斜缩放顺序预设相机原点	得到 put 删除	56		0 01
相机.firstPreset 相机首先以平移倾斜缩放顺序预设。	得到 put 删除	57		0 01
camera.second 预设平移倾斜缩放顺序中的相机第二个预设。	得到 put 删除	58		0 01
相机.savePresetHome 将当前 PTZ 值保存到主页预设。	邮政	12	不适用	不适用
相机.savePresetFirst 将当前 PTZ 值保存到第一个预设。	邮政	17	不适用	不适用
相机.savePresetSecond 将当前 PTZ 值保存到第二个预设。	邮政	18	不适用	不适用

名称/描述	操作	命令 ID	值的范围	默认值
相机应用主动预设将活动预设应用于 PTZ 设置。	邮政	OF	不适用	不适用
相机.active 预设这是活动预设。请注意，在相机启动或重新启动时，活动预设设置为 Home。	得到 put 删除	13	11213	1
相机状态相机状态。激活时，摄像头正在流式传输视频。不活动时，相机不会流式传输。升级时，相机正在升级固件。	得到	60	活跃I不活跃I升级	不活跃
自动成帧状态打开/关闭相机自动取景功能。	得到 put 删除	19	110	0
蓝牙.pairingStateToggle 将配对状态从开/关切换到关/开。	邮政	C6	不适用	不适用
蓝牙配对状态蓝牙配对状态。开启状态将允许在固定间隔内与设备配对。一旦配对间隔结束，状态将变为关闭。	放上去	14	110	0
蓝牙状态蓝牙和 BLE 状态。开启状态将表明蓝牙和 BLE 开启；关闭状态将指示蓝牙和 BLE 已关闭。	得到	67	110	0
蓝牙配对配对的设备名称。	得到	6A	细绳（0-128 个字符）	没有设置
蓝牙连接配对设备连接状态。	得到	6B	110	0
蓝牙.streamState 蓝牙的流状态。	得到	C2	110	0
蓝牙.callState 蓝牙通话状态。	得到	6C	110	0
蓝牙断开连接断开蓝牙设备。	邮政	E4	11213	不适用
网络.dhcpState DHCP 状态。当 DHCP 状态开启时，网络将通过 DHCP 进行配置。当 DHCP 状态关闭时，使用静态值。	得到 put 删除	74	110	1
网络.ip (VBl) DHCP 状态关闭时的静态 IP 地址。	得到 put 删除	75		（在 VBl 中支持） 0.0.0.0
网络状态 (VBl) 以太网模块的状态。	得到	7F	闲置失败！关联我配置我准备好了我断开！在线的	（在 VBl 中支持）准备就绪

名称/描述	操作	命令 ID	值的范围	默认值
网络.mac (VBXNUMX) LAN 接口的 MAC 地址。	得到	80		（在 VBl 中支持）00:00:00:00:00:00
wifi.dhcp状态 DHCP 状态。当 DHCP 状态开启时，WiFi 将通过 DHCP 进行配置。当 DHCP 状态关闭时，使用静态值。	得到 put 删除	Al	110	1
wifi.ip DHCP 状态关闭时的静态 IP 地址。	得到 put 删除	A2		0.0.0.0
无线网络.mac WiFi接口的MAC地址。	得到	AC		00:00:00:00:00:00
wifi.状态 WiFi 模块的状态。	得到	BO	闲置失败！关联我配置我准备好了我断开！在线的	闲置的
遥测.peopleCount (VBXNUMX) 相机自动取景算法计算的人数。	得到 put 删除	DA	0-99	（在 VBl 中支持） 0
遥测.peoplePresent (VBXNUMX) 当相机自动取景算法检测到任何人时为真。	得到 put 删除	DC	110	（在 VBl 中支持） 0

文件/资源

BOSE 工作休息 API 应用程序 [pdf] 用户指南
工作、休息 API、应用、工作休息 API 应用

参考

用户手册

BOSE 工作休息 API 应用程序

介绍

商标公告

隐私信息

启用和配置 REST API

测试 REST API

REST API 命令

得到

放

邮政

删除

Videobar REST API 命令参考

文件/资源

参考

发表评论

取消回复