中控HttpApi鉴权说明
由于添加了鉴权机制,需要先执行鉴权流程,成功后拿到token,后续接口调用附上该token校验OST形式请求鉴权,附带password参数(值为请求的设备的admin密码):
POST /centralcontrol/authentication
{
"password": "0000"
}
若请求且校验成功,会获取到一串token:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"token":"6118C27AAC154D79BFC955A4F63E3C42"
}
}
1. token使用方式
获取到的token字段填在https请求头中的 "Authorization" 字段内作为认证校验字段值:
User-Agent: PostmanRuntime-ApipostRuntime/1.1.0
Cache-Control: no-cache
content-type: application/json
Accept: */*
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Authorization: Bearer 6118C27AAC154D79BFC955A4F63E3C42
Content-Length: 27
后续所有请求都需要带上该token才能校验成功并执行对应功能,若访问的是app相关的接口需要带上app名称参数,,以Apipost软件为例:
image.png
2. 业务鉴权失败
支持机型 Yealink RoomConnect,UVC40
当业务请求时,若出现鉴权失败,将会回复以下响应实例:
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 500,
"data": {
"error-code": 10007,
"error-msg": "password-incorrect"
}
}
此时,客户端可重新进行鉴权请求。
3. 处理超过限制
支持机型 NS
如果业务请求并发量超过十个,就会触发服务器并发量限制机制,将会回复以下响应实例
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 500,
"data":
{
"error-code": 10007,
"error-msg": "password-incorrect"
}
}
中控HttpApi错误码说明
当业务执行失败,status字段会返回“404”(鉴权相关可查阅“准入服务”和“鉴权说明”),此时API会包含error-code和error-msg字段,表示该接口调用返回的错误码及错误信息,调用者可以根据该字段确认错误原因。具体定义如下:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 404,
"data":
{
"error-code": 10002,
"error-msg": "not-support"
}
}
错误码/错误信息介绍:
错误码 错误信息 解释
10001 unknown 未知错误
10002 not-support 不支持
10003 invalid-param 参数错误
10004 busy 设备繁忙不允许执行某些操作(通话中)
10005 file-gen-fail 文件生成失败
10006 permission-denied 此操作未有权限
10007 password-incorrect 鉴权密码错误,获取鉴权token失败
10008 refresh-token-fail 刷新鉴权token失败
10009 authentication-required 鉴权失败
10010 exceed-maximum-concurrency 超过服务器最大并发量
10011 task-process-no-exist 任务进程已经不存在,需要重新开始;例子:抓包未开始或抓包超时被动结束后,进行get操作
准入服务
鉴权准入
1. 鉴权
基本信息
Method: POST
Path: /centralcontrol/authentication
支持机型 Yealink RoomConnect,UVC40
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
password string \ 是 鉴权密码
返回值:
名称 类型 取值范围 备注
token string \ 鉴权成功的token
备注
请求示例
POST /centralcontrol/authentication
{
"password": "0000"
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"token":"6118C27AAC154D79BFC955A4F63E3C42"
}
}
基础信息
基础信息查询/获取(本文档包含系统信息、网络信息、设备列表,其余系统状态、静音状态、音量大小、摄像头信息、屏幕亮度、会议平台列表可查阅 控制服务文档)
1. 获取系统信息(建议用6)
基本信息
Method: GET
Path: /centralcontrol/system/version
支持机型 UVC40
请求参数:
Body:
无
返回值:
名称 类型 备注
model string 设备类型
firmware string 固件版本号
hardware string 硬件版本号
serialnumber string 设备sn号
macaddress string 设备mac地址
cc-version string 中控版本
备注
请求示例
GET /centralcontrol/system/version
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"model":"MeetingEye 500",
"firmware":"128.423.253.104",
"hardware":"263.0.19.0.3.0.36",
"macaddress":"00:15:65:00:00:00",
"serialnumber":"506607D117000009",
"cc-version":"1.0.0.11"
}
}
2. 获取网络信息
基本信息
Method: GET
Path: /centralcontrol/network/info
支持机型 UVC40,SmartVision 40
请求参数:
Body:
无
返回值:
名称 类型 取值范围 备注
network-list network_info [] \ 网络信息列表
network_info
名称 类型 取值范围 备注
type int [0,1] 获取网络方式0:动态获取1:静态设置
port-type int [0,1,2,3] 网口类型0:有线网口11:有线网口22:无线网口3:AP网口
mode int [0,1,2] IP类型0:IPv41:IPv62:IPv4和IPv6
ip string 无 IP地址
mask string 无 子网掩码
gateway string 无 网关
primary-dns string 无 首选dns服务器名
second-dns string 无 备选dns服务器名
mac string 无 网卡mac地址
备注
请求示例
GET /centralcontrol/network/info
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data": {
"network-list": [
{
"type": 0,
"port-type": 2,
"mode": 0,
"ip": "",
"mask": "",
"gateway": "",
"primary-dns": "",
"second-dns": "",
"mac":"44:DB:D2:71:55:76"
},
{
"type": 0,
"port-type": 0,
"mode": 0,
"ip": "10.50.149.143",
"mask": "255.255.255.0",
"gateway": "10.50.149.254",
"primary-dns": "10.100.1.10",
"second-dns": "192.168.1.22",
"mac":"44:DB:D2:90:57:F9"
}
]
}
}
3. 获取设备列表
基本信息
Method: GET
Path: /centralcontrol/system/devices
支持机型 Yealink RoomConnect,SmartVision 40
请求参数:
Body:
无
返回值:
名称 类型 取值范围 备注
device-list device_info [] \ 设备信息列表
device_info
名称 类型 备注
model string 设备类型
firmware string 固件版本号
hardware string 硬件版本号
serialnumber string 设备sn号
macaddress string 设备mac地址
id int 设备标识(可用于设置或获取屏幕参数)
备注
请求示例
GET /centralcontrol/system/devices
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"device-list": [
{
"model":"UVC86",
"firmware":"128.423.253.104",
"hardware":"263.0.19.0.3.0.36",
"macaddress":"00:15:65:00:00:00",
"serialnumber":"506607D117000009",
"id": 0
},
{
"model":"UVC84",
"firmware":"130.303.253.44",
"hardware":"261.0.5.10.43.0.58",
"macaddress":"00:24:13:00:00:00",
"serialnumber":"803032E070000031",
"id": 1
}
]
}
}
4. 获取app信息列表
基本信息
Method: GET
Path: /centralcontrol/app/info
支持机型 NS
请求参数:
Body:
无
返回值:
名称 类型 取值范围 备注
app-list app_list [] \ 设备信息列表
app_list
名称 类型 备注
id string app包名
name string app名称
version string app版本号
备注
请求示例
GET /centralcontrol/app/info
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"app-list": [
{
"id":"com.yealink.byod",
"name":"BYOD",
"version":"1.0"
},
{
"id":"com.yealink.projection",
"name":"投屏",
"version":"21.1.2-TS.2"
}
]
}
}
5. 获取通话状态
基本信息
Method: GET
Path: /centralcontrol/system/call-state
支持机型 SmartVision 40 注意: 1、SmartVision 40 只支持获取incall和idle
请求参数:
Body:
无
返回值:
名称 类型 取值范围 参数说明
call-state string [incoming, incall, idle] incoming:来电中incall:正在通话idle:空闲incoming、incall两种状态可视为通话中
app-info app_info \ 正在通话中的app信息,若非通话中或没有权限获取对应APP信息,则对应信息都为 ""
app_info
名称 类型 备注
id string app包名
name string app名称
version string app版本号
备注
请求示例
GET /centralcontrol/system/call-state
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"call-state": "incoming",
"app-info": {
"id":"",
"name":"",
"version":""
}
}
}
6. 获取系统信息
基本信息
Method: GET
path: /centralcontrol/system/sys-info
支持机型 SmartVision 40
请求参数
Body
无
返回值
名称 类型 参数说明
model string 设备机型
firmware string 软件版本号
hardware string 硬件版本号
serialnumber string 设备sn号
macaddress string 设备mac地址
cc-version string 中控版本号
vendor string 设备厂商名称
os-version string 安卓大版本号(只有安卓机型支持该参数)
备注
请求示例
GET /centralcontrol/system/sys-info
{
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"model": "SmartVision40",
"firmware": "286.412.0.6",
"hardware": "286.0.16.0.0.0.0",
"serialnumber": "506656F110000056",
"macaddress": "24:9a:d8:db:a2:3b",
"cc-version": "1.0.0.16",
"vendor": "Yealink",
"os-version": "Android 13"
}
}
7. 获取USB接口的连接状态
基本信息
Method: GET
Path: /centralcontrol/system/pc-connect-status
支持机型 SmartVision 40
请求参数
Body
无
返回值
名称 类型 取值范围 说明
status string [on,off] USB连接状态:on:连接off:未连接
备注
请求示例
GET /centralcontrol/system/pc-connect-status
{
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"status": "on"
}
}
8. 读取内存使用情况
基本信息
Method: GET
Path: /centralcontrol/system/memory-info
支持机型 SmartVision 40
请求参数
Body
无
返回值
名称 类型 取值范围 说明
memory-usage int [0,100] 内存使用率
total-memory int >0 总内存,单位Mb
free-memory int >=0 未使用内存,单位Mb
used-memory int >0 已使用内存,单位Mb
备注
请求示例
GET /centralcontrol/system/memory-info
{
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"memory-usage": 21,
"total-memory": 953,
"free-memory": 744,
"used-memory": 209
}
}
9. 读取设备状态
基本信息
Method: GET
Path: /centralcontrol/system/alert-status
支持机型 SmartVision 40
请求参数
Body
无
返回值
名称 类型 取值范围 说明
normal string [true,false] 设备是否正常 normal = !(memorytoohigh|| cpuusagetoohigh)
memorytoohigh string [true,false] 内存占用是否过高,默认大于80返回true
cpuusagetoohigh string [true,false] cpu占用是否过高,默认大于80返回true
cputemptoohigh string [true,false] cpu温度是否过高,默认大于80返回true
备注
请求示例
GET /centralcontrol/system/alert-status
{
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"normal": "true",
"memorytoohigh": "false",
"cpuusagetoohigh": "false",
"cputemptoohigh":"false"
}
}
10. 设置告警信息规则
基本信息
Method: POST
Path: /centralcontrol/system/alert-rules
支持机型 SmartVision 40
请求参数
Body
名称 类型 取值范围 参数
cpu int [0,100] 设置cpu使用率过高的阈值,单位:%,默认为80,请求参数为取值范围之外的数值时,设置为默认值
memory int [0,100] 设置memory使用率过高的阈值,单位:%,默认为80,请求参数为取值范围之外的数值时,设置为默认值
cputemp int >=0 设置cpu温度过高的阈值,单位:摄氏度,默认为80,请求参数为取值范围之外的数值,设置为默认值
返回值
无
备注
请求示例
POST /centralcontrol/system/alert-rules
{
"cpu":70,
"memory":90,
"cputemp":100
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200
}
11. 获取当下时间
基本信息
Method: GET
Path: /centralcontrol/system/current-time
支持机型 SmartVision 40
请求参数
Body
无
返回值
参数 类型 取值范围 说明
value int NA linux时间戳
timezone string NA 时区,区域表示法
备注
请求示例
GET /centralcontrol/system/current-time
{
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"value": 1725480149,
"timezone":"Asia/shanghai"
}
}
12. 获取BYOD-EXTENDER的状态
基本信息
Method: GET
Path: /centralcontrol/byod/extender-status
支持机型 Yealink RoomConnect
请求参数
Body
无
返回值
名称 类型 取值范围 说明
status string [available,in_use, disconnected, unknown] USB连接状态:available: MVC-BYOD-Extender连接主机,但未使用in_use: MVC-BYOD-Extender使用中disconnected: MVC-BYOD-Extender未连接unknown: 未知状态
sn string NA 设备序列号
备注
请求示例
GET /centralcontrol/byod/extender-status
{
"sn": "8654611N542H00001"
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"status": "available"
}
}
13、查询当前所在的单应用模式
基本信息
Method: GET
Path: /centralcontrol/app/current-info
支持机型 NS
请求参数
Body
无
返回值
名称 参数类型 取值范围 说明
name string NA 应用的包名,只有通过api切换应用才可以正常进程查询
备注
请求示例
GET /centralcontrol/app/current-info
{
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"name": "com.bytedance.viewroom.controller"
}
}
控制服务
对设备的音视频设备,显示以及整机进行远程控制,包括控制时需要的状态获取。
1. 系统状态控制
1). 获取系统状态
基本信息
Method: GET
Path: /centralcontrol/system/status
支持机型 NS
请求参数:
Body:
无
返回值:
名称 类型 取值范围 参数说明
status string [sleeping,wake-up] 系统状态sleeping:休眠wake-up:唤醒
备注
请求示例
GET /centralcontrol/system/status
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"status":"wake-up"
}
}
2). 设置系统状态
基本信息
Method: POST
Path: /centralcontrol/system/status
支持机型 Yealink RoomConnect,UVC40, SmartVision 40 注意: 1、Yealink RoomConnect/UVC仅支持重启,恢复出厂 2、仅Yealink RoomConnect支持传sn参数 3、SmartVision 40相关场景仅支持重启
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
status string [sleeping,wake-up,reboot,reset] 是 系统状态sleeping:休眠wake-up:唤醒reboot:重启reset:恢复出厂
sn string \ 否 设备唯一标识sn
返回值:
无
备注
请求示例
POST /centralcontrol/system/status
{
"status":"sleeping",
"sn":"506607D117000009"
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
}
3). 获取工作时间
基本信息
Method: GET
Path: /centralcontrol/system/uptime
支持机型 SmartVision 40
请求参数:
Body:
无
返回值:
名称 类型 取值范围 参数说明
value int >0 工作时长(以分钟为单位)
备注
请求示例
GET /centralcontrol/system/uptime
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"value":840
}
}
4). 获取CPU信息
基本信息
Method: GET
Path: /centralcontrol/system/cpu-info
支持机型 SmartVision 40 注意:1、SmartVision 40 支持cpu-temp
请求参数:
Body:
无
返回值:
名称 类型 取值范围 参数说明
cpu-usage int [1~100] cpu占用率(以百分之一为单位)
cpu-temp int [-10,100] cpu温度,单位℃
备注
请求示例
GET /centralcontrol/system/cpu-info
{
}
SmartVision 40:
GET /centralcontrol/system/cpu-info
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"cpu-usage":25
}
}
SmartVision 40:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"cpu-usage": 10,
"cpu-temp": 67
}
}
5). 设置设备当前分割状态
基本信息
Method: POST
Path: /centralcontrol/system/division
支持机型 NS
请求参数:
名称 类型 取值范围 是否必须 参数说明
value int [0, 1] 是 0:合并状态 1:分割状态
返回值: 无
备注
请求示例
POST /centralcontrol/system/division
{
"value":1
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200
}
6). 获取设备当前分割状态
基本信息
Method: GET
Path: /centralcontrol/system/division
支持机型 NS
请求参数:
名称 类型 取值范围 是否必须 参数说明
value int [0, 1] 是 0:合并状态 1:分割状态
返回值: 无
备注
请求示例
GET /centralcontrol/system/division
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":{
"value":1
}
}
7). 查询设备当前硬件状态(已弃用,建议用8)
基本信息
Method: GET
Path: /centralcontrol/system/hardware
支持机型 NS
请求参数:
名称 类型 取值范围 参数说明
» hardware_list body [object] 是
»» type body string 是
»» index body [string] 否
返回值: 无
备注
请求示例
GET /centralcontrol/system/hardware
{
"hardware_list": [
{
"type": "gpio",
"index": [
"1",
"2"
]
}
]
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"hardware_list": [
{
"type": "gpio",
"status": [
{
"index": "1",
"status": "0"
},
{
"index": "2",
"status": "1"
}
]
}
]
}
}
8). 获取gpio状态
基本信息
Method: GET
Path: /centralcontrol/system/hardware
支持机型 NS
请求参数:
名称 类型 取值范围 参数说明
» hardware_list body [object] 是
»» type body string 是
»» index body [string] 否
返回值:
无
备注
请求示例
GET /centralcontrol/system/gpio-status
{
"hardware_list": [
{
"type": "gpio",
"index": [
"1",
"2"
]
}
]
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data": {
"hardware_list": [
{
"type": "gpio",
"status": [
{
"index": "1",
"status": "0"
},
{
"index": "2",
"status": "1"
}
]
}
]
}
}
9). 设置设备定位开关
基本信息
Method: POST
Path: /centralcontrol/system/status
支持机型 NS
请求参数
Body:
名称 类型 取值范围 说明
status string {on,off} on:开启设备定位off:关闭设备定位
返回值
无
备注
请求示例
POST /centralcontrol/system/status
{
"status":"on"
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200
}
10). 设置LED灯开关
基本信息
Method: POST
Path: /centralcontrol/sysytem/led-preset/enable
支持机型 NS
请求参数
Body:
名称 类型 取值范围 是否必须 参数说明
enable string {on,off} 是 on:开启LED灯off:关闭LED灯
返回值
无
备注
请求示例
POST /centralcontrol/system/led-preset/enable
{
"enable":"off"
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200
}
11). 获取LED开关状态
基本信息
Method: GET
Path: /centralcontrol/sysytem/led-preset/enable
支持机型 NS
请求参数
Body:
无
返回值
名称 类型 取值范围 参数说明
enable string {on,off} on:开启状态off:关闭状态
备注
请求示例
GET /centralcontrol/system/led-preset/enable
{
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200,
"data":{
"enable":"on"
}
}
12). 设置LED灯颜色预设
基本信息
Method: POST
Path: /centralcontrol/sysytem/led-preset/config
支持机型 NS
请求参数
Body:
名称 类型 取值范围 是否必须 参数说明
color string {red,green,oriange,#xxxxxx} 是 支持三种预制颜色,红绿橙。也支持RGB16进制任意颜色(红绿橙除外)。
event string {mute,unmute} 是 对应要设置的事件
返回值
无
备注
请求示例
POST /centralcontrol/sysytem/led-preset/config
{
"color":"red",
"event":"mute"
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200
}
13). 获取LED灯颜色预设
基本信息
Method: GET
Path: /centralcontrol/sysytem/led-preset/config
支持机型 NS
请求参数
Body:
名称 类型 取值范围 是否必须 参数说明
event string {mute,unmute} 是 要查询灯颜色的事件
返回值
名称 类型 取值范围 是否必须 参数说明
color string {red,green,oriange,#xxxxxx} 是 三种预制颜色,红绿橙。或RGB16进制任意颜色(红绿橙除外)。
event string {mute,unmute} 是 对应的事件
备注
请求示例
GET /centralcontrol/sysytem/led-preset/config
{
"event":"unmute"
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200
"data":{
"event":"unmute",
"color":"#145386"
}
}
14)设置当前时间
基本信息
Method: POST
Path: /centralcontrol/system/time
支持机型 NS
请求参数
Body:
名称 类型 取值范围 参数说明
year int NA 年
month int [0-12] 月
day int [0-31] 日
hour int [0-23] 时
minute int [0-59] 分
second int [0-59] 秒
hour_format int [0-1] 小时制,0:12小时制,1:24小时制。无论12小时制还是24小时制,hour都要按照24小时制设置
返回值
无
备注
请求示例
POST /centralcontrol/system/time
{
"year":2025,
"month":9,
"day":30,
"hour":19,
"minute":30,
"second":0,
"hour_fromat":1
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status": 200
}
2. 音频控制
1). 获取静音状态
基本信息
Method: GET
Path: /centralcontrol/audio/mute
支持机型 UVC40:以上机型已弃用建议使用mic-muteAVHub,UVC86,SmartVision 80
请求参数:
Body:
无
返回值:
名称 类型 取值范围 参数说明
status string [on,off] 静音状态on:打开off:关闭
备注
请求示例
GET /centralcontrol/audio/mute
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"status":"on"
}
}
2). 设置静音状态(MVC机型)
基本信息
Method: POST
Path: /centralcontrol/audio/mute
支持机型 UVC40, Yealink RoomConnect,SmartVision 40,AVHub,UVC86,SmartVision 80
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
status string [on,off] 是 静音状态on:打开off:关闭
返回值:
无
备注
请求示例
POST /centralcontrol/audio/mute
{
"status": "off"
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
}
3). 设置静音状态(VCS机型)
基本信息
Method: POST
Path: /centralcontrol/button
支持机型 NS
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
key string [mute] 是 按键名
返回值:
无
备注
请求示例
POST /centralcontrol/button
{
"key": "mute"
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200
}
4). 获取音量
基本信息
Method: GET
Path: /centralcontrol/audio/volume
支持机型 UVC40、 Yealink RoomConnect
请求参数:
Body:
无
返回值:
名称 类型 取值范围 参数说明
value int [0~15] 音量值
备注
请求示例
GET /centralcontrol/audio/volume
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"value":5
}
}
5). 设置音量
基本信息
Method: POST
Path: /centralcontrol/audio/volume
支持机型 NS
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
value int [0-15] 是 音量值
type string [idle,talk] 否 音量类型idle:铃声音量talk:通话音量
返回值:
无
备注
请求示例
POST /centralcontrol/audio/volume
{
"type": "idle",
"value": 3
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
}
6). 获取音频源列表
基本信息
Method: GET
Path: /centralcontrol/audio/source-info
支持机型 NS
请求参数:
Body:
无
返回值:
名称 类型 参数说明
input-source string 输入源列表
output-source string 输出源列表
备注
请求示例
GET /centralcontrol/audio/source-info
{
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"input-source": [
"AUTO",
"WIRED_MIC",
"LINE",
"XLR"
],
"output-source": [
"AUTO",
"HDMI",
"LINE",
"WIRED_SPEAKER"
]
}
}
7). 设置音频输入源
基本信息
Method: POST
Path: /centralcontrol/audio/input-source
支持机型 NS
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
type string 仅支持获取音频源列表取到输入源信息内容 是 音频输入源标识AUTO:自动VCP:CP96X设备LINE:线性输入USB_LINE:USB转线性输入BUILT_IN: 内置麦HANDSET: 手柄BT_HANDSET: 蓝牙手柄WIRED_MIC:有线麦WIRELESS_MIC:无线麦XLR: 三针插口输入
返回值:
无
备注
请求示例
POST /centralcontrol/audio/input-source
{
"type": "AUTO"
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
}
8). 设置音频输出源
基本信息
Method: POST
Path: /centralcontrol/audio/output-source
支持机型 NS
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
type string 仅支持获取音频源列表取到输出源信息内容 是 音频输出源标识AUTO:自动VCP:CP96X设备HDMI:hdmiLINE:线性输出USB_LINE:USB转线性输出BUILT_IN:内置扬声器HEADSET: 耳机BT_HEADSET: 蓝牙耳机WIRED_SPEAKER:有线扬声器
返回值:
无
备注
请求示例
POST /centralcontrol/audio/output-source
{
"type": "VCP"
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
}
9). 设置输入音频降噪
基本信息
Method: POST
Path: /centralcontrol/audio/input/noise-reduction
支持机型 Yealink RoomConnect 注意: 1、ai-mode适用的机型:AVHub,UVC84,UVC86 2、level适用的机型:AVHub,UVC84,UVC86, VCM34, VCM35, VCM38, CM20
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
ai-mode string [on,off] 否 AI智能降噪模式on:打开 off:关闭
level int [0,1,2,3] 否 抑制等级0:关 1:弱 2:正常 3:强
sn string 无 否 设备唯一标识
返回值:
无
备注
请求示例
POST /centralcontrol/audio/input/noise-reduction
{
"sn":"506607D117000009",
"ai-mode": "on",
"level":2
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
}
10). 设置输入音频增益
基本信息:
Method: POST
Path: /centralcontrol/audio/input/gain
支持机型 Yealink RoomConnect 注意: 1、rca-value与line-value参数仅对调节的设备是AVHub生效
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
status string [on,off] 是 增益控制状态 on:打开 off:关闭
gain-value int [-30~30] 否 增益调节值
rca-value int [-12~40] 否 RCA输入调节值
line-value int [-12~40] 否 Line输入调节值
attenuation-value int [-30~30] 否 衰减调节值
sn string 无 否 设备唯一标识
返回值:
无
备注
请求示例
POST /centralcontrol/audio/input/gain
{
"status":"on",
"sn":"506607D117000009",
"gain-value":20,
"rca-value":-6,
"attenuation-value":30,
"line-value":12
}
响应实例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
}
11). 设置输入音频回声消除
基本信息
Method: POST
Path: /centralcontrol/audio/input/echo-cancellation
支持机型 Yealink RoomConnect
请求参数:
Body:
名称 类型 取值范围 是否必须 参数说明
status string [on,off] 是 回声消除状态on:打开 off:关闭
suppress-level int [0,1,2] 否 回声消除等级0:低 1:中 2:高
reverb-level int [0,1,2] 否 房间混响等级 0:低 1:中 2:高
manual-dalay string [on,off] 否 手动延迟 on:打开 off:关闭
delay-value int [-100~500] 否 音频AEC延迟数 (单位:ms)
sn string 无 否 设备唯一标识
返回值:
无
备注
请求示例
POS