中控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软件为例： 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 无 否 设备唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/audio/input/echo-cancellation { "status":"on", "sn":"506607D117000009", "suppress-level":1, "reverb-level":0, "manual-dalay":"on", "delay-value":200 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, } 12）. 设置输入音频均衡器 基本信息 Method: POST Path: /centralcontrol/audio/input/equalizer 支持机型 Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 均衡器状态 on：打开 off：关闭 mode string [custom,bass-boost, treble-boost,vocal-boost] 是 均衡器模式 custom：自定义 bass-boost：低音增强 treble-boost：高音增强 vocal-boost：人声增强 frequency-range-list int [-12~12] 否 自定义模式频段列表，列表数据分别对应：20hz，63hz，125hz，250hz，500hz，1000hz，2000hz，4000hz，8000hz，20000hz sn string 无 否 设备唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/audio/input/equalizer { "sn":"506607D117000009", "status": "on", "mode":"custom", "frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, } 13）. 设置输出音频增益 基本信息 Method： POST Path： /centralcontrol/audio/output/gain 支持机型 Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 增益控制状态 on：打开 off：关闭 gain-value int [-30~30] 否 增益调节值 attenuation-value int [-30~30] 否 衰减调节值 line-value int [-50-30] 否 Line输出调节值 sn string 无 否 设备唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/audio/output/gain { "status":"on", "sn":"506607D117000009", "gain-value":20, "attenuation-value":30, "line-value": 10 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, } 14）. 设置输出音频均衡器 基本信息 Method: POST Path: /centralcontrol/audio/output/equalizer 支持机型 Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 均衡器状态on：打开off：关闭 mode string [custom,bass-boost, treble-boost,vocal-boost] 是 均衡器模式custom：自定义bass-boost：低音增强 treble-boost：高音增强 vocal-boost：人声增强 frequency-range-list int [-12~12] 否 自定义模式频段列表，列表数据分别对应：20hz，63hz，125hz，250hz，500hz，1000hz，2000hz，4000hz，8000hz，20000hz sn string 无 否 设备唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/audio/output/equalizer {     "sn":"506607D117000009", "status": "on", "mode":"custom", "frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, } 15）. 获取mic静音状态 基本信息 Method： GET Path： /centralcontrol/audio/mic-mute 支持机型 UVC40 请求参数： 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" } } 16）. 获取扬声器静音状态 基本信息 Method： GET Path： /centralcontrol/audio/speaker-mute 支持机型 SmartVison 40 请求参数 Body： 无 返回值 名称 类型 取值范围 说明 status string [on,off] mute状态： on:开启 off:关闭 备注 请求示例 GET /centralcontrol/audio/speaker-mute { } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200, "data": { "status": "off" } } 17）.读取Audio Fence开关状态 基本信息 Method： GET Path： /centralcontrol/audio/fence-enable 支持机型 SmartVision 40 请求参数 Body： 无 返回值 名称 类型 取值范围 说明 status string [on,off] 音频墙的开关状态： on:开启 off:关闭 备注 请求示例 GET /centralcontrol/audio/fence-enable { } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200, "data": { "status": "on" } } 18）. 获取设备声源通道信息（已弃用，建议用19） 基本信息 Method： GET Path： /centralcontrol/audio/device-sound/channel-info 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 是否必须 参数说明 max_channel_count int \ 是 最大通道数 channel_enable bool[] \ 是 通道使能状态 备注 请求示例 GET /centralcontrol/audio/device-sound/channel-info { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "max_channel_count": 8, "channel_enable": [ true, true, true, true, true, true, true, true ] } 19）. 获取设备声源通道信息 基本信息 Method： GET Path： /centralcontrol/audio/lobe-enable 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 是否必须 参数说明 max_channel_count int \ 是 最大通道数 channel_enable bool[] \ 是 通道使能状态 备注 请求示例 GET /centralcontrol/audio/lobe-enable { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "max_channel_count": 8, "channel_enable": [ true, true, true, true, true, true, true, true ] } 20）. 获取设备声源通道激活状态（已弃用，建议用21） 基本信息 Method： GET Path： /centralcontrol/audio/device-sound/active-status 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 是否必须 参数说明 active_status bool[] 无 是 通道激活状态 备注 请求示例 GET /centralcontrol/audio/device-sound/active-status { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "active_status": [ true, true, true, true, true, true, true, true ] } 21）. 获取设备声源通道激活状态 基本信息 Method： GET Path： /centralcontrol/audio/lobe-activation 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 是否必须 参数说明 active_status bool[] 无 是 通道激活状态 备注 请求示例 GET /centralcontrol/audio/lobe-activation { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "active_status": [ true, true, true, true, true, true, true, true ] } 22）. 获取发言者位置坐标（已弃用，建议用23） 基本信息 Method： GET Path： /centralcontrol/audio/device-sound/talker-position 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 是否必须 参数说明 »doa object[] 无 是 设备doa数组信息 »»dev_type string 无 是 设备类型 »»dev_sn string 无 是 设备SN »»snd_src_num int 无 是 设备SN »»snd_src object[] 无 是 声源数据 »»»x int 无 是 x轴数值 »»»y int 无 是 y轴数值 »»»z int 无 是 z轴数值 备注 请求示例 GET /centralcontrol/audio/device-sound/talker-position { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "doa": [ { "dev_type": "CM50", "dev_sn": "sfsfsfsff", "snd_src_num": 1, "snd_src": [ { "x": 0, "y": 0, "z": 0 } ] } ] } 23）. 获取发言者位置坐标 基本信息 Method： GET Path： /centralcontrol/audio/sound-locate 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 是否必须 参数说明 doa object[] \ 是 设备doa数组信息 doa： 名称 类型 取值范围 是否必须 参数说明 dev_type string \ 是 设备类型 dev_sn string \ 是 设备SN snd_src_num int \ 是 设备SN snd_src object[] \ 是 声源数据 x int \ 是 x轴数值 y int \ 是 y轴数值 z int \ 是 z轴数值 snd_src: 名称 类型 取值范围 是否必须 参数说明 x int \ 是 x轴数值 y int \ 是 y轴数值 z int \ 是 z轴数值 备注 请求示例 GET /centralcontrol/audio/sound-locate { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "doa": [ { "dev_type": "CM50", "dev_sn": "sfsfsfsff", "snd_src_num": 1, "snd_src": [ { "x": 0, "y": 0, "z": 0 } ] } ] } 24）. 获取音频参数预设（已弃用，建议用25） 基本信息 Method： GET Path：/centralcontrol/audio/param/preset 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 必选 约束 说明 »preset_info [object] true none none »»preset_type string true none none »»preset_id string true none 预设的唯一ID »»preset_name string true none preset_type为官方预设时，name和id一致 备注 请求示例 GET /centralcontrol/audio/param/preset { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "preset_info":{ preset_type: "custom_preset", preset_id: "自定义1", preset_name: "OFQjdE", } } 25）. 获取音频参数预设 基本信息 Method： GET Path：/centralcontrol/audio/preset 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 说明 »preset_info preset_info[] \ none »»preset_type string \ none »»preset_id string \ 预设的唯一ID »»preset_name string \ preset_type为官方预设时，name和id一致 备注 请求示例 GET /centralcontrol/audio/preset { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "preset_info":{ preset_type: "custom_preset", preset_id: "自定义1", preset_name: "OFQjdE", } } 26）. 设置音频参数预设（已弃用，建议用27） 基本信息 Method： POST Path： /centralcontrol/audio/param/preset 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 value string \ 是 预设名称 返回值： 无 备注 请求示例 POST /centralcontrol/audio/param/preset {     "value":"1" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, } 27）. 设置音频参数预设 基本信息 Method： POST Path： /centralcontrol/audio/preset 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 value string \ 是 预设名称 返回值： 无 备注 请求示例 POST /centralcontrol/audio/preset {     "value":"1" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, } 28）. 设置增益(已弃用，建议用29) 基本信息 Method： POST Path： /centralcontrol/audio/gain 支持机型 NS 请求参数： Body: 名称 类型 必选 约束 说明 » arr_gain_info [object] true none none »» name string true none Designer UI 上显示的通道名称 »» value integer true [-60, 20] none 返回值： 无 备注 请求示例 POST /centralcontrol/audio/gain { "arr_gain_info": [ { "name": "USB-Input-1", "value": 10 }, { "name": "USB-Input-2", "value": 10 } ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 29）. 设置通道增益 基本信息 Method： POST Path： /centralcontrol/audio/channel/gain 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 » arr_gain_info arr_gain_info[] \ 是 none »» name string \ 是 Designer UI 上显示的通道名称 »» value int [-60,20] 是 none 返回值： 无 备注 请求示例 POST /centralcontrol/audio/channel/gain { "arr_gain_info": [ { "name": "USB-Input-1", "value": 10 }, { "name": "USB-Input-2", "value": 10 } ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 30）. 获取增益(已弃用，建议用31) 基本信息 Method： GET Path： /centralcontrol/audio/gain 支持机型 NS 请求参数： Body: 名称 类型 必选 约束 说明 » arr_gain_info body [string] 是 \ 返回值： 无 备注 请求示例 GET /centralcontrol/audio/gain { "arr_gain_info": [ "USB-Input-1", "USB-Input-2" ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200, "data": { "arr_gain_info": [ { "name": "USB-Input-1", "value": 10 }, { "name": "USB-Input-2", "value": 10 } ] } } 31）. 获取通道增益 基本信息 Method： GET Path： /centralcontrol/audio/channel/gain 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 arr_gain_info string[] desiger上的通道名称 否 参数为空时，默认返回所有的通道的增益值 返回值： 名称 类型 取值范围 参数说明 »arr_gain_info arr_gain_info[] \ \ »»name string \ 要查询的通道名称 »»value int [-60,20] 对应通道的增益的值 备注 请求示例 GET /centralcontrol/audio/channel/gain { "arr_gain_info": [ "USB-Input-1", "USB-Input-2" ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200, "data": { "arr_gain_info": [ { "name": "USB-Input-1", "value": 10 }, { "name": "USB-Input-2", "value": 10 } ] } } 32）. 设置音频外部输入降噪 基本信息 Method： POST Path： /centralcontrol/audio/external-input/noise-reduction 支持机型 Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 level int [0,1] 是 降噪控制等级1：打开 0：关闭 sn string 无 否 设备唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/audio/external-input/noise-reduction { "level": 0, "sn":"506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 33）. 设置设备通道mute状态（已弃用，建议用34） 基本信息 Method： GET Path： /centralcontrol/audio/channel-mute 支持机型 NS 请求参数： Body: 名称 类型 必选 约束 说明 » channel_mute [object] true none none »» name string true none Designer UI 上显示的通道名称 »» status string true [off, on] none 返回值： 无 备注 请求示例 POST /centralcontrol/audio/channel-mute { "channel_mute": [ { "name": "Dante-Input-1", "status": "on" }, { "name": "Dante-Input-2", "status": "off" }, ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 34）. 设置设备通道mute状态 基本信息 Method： GET Path： /centralcontrol/audio/channel/mute 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 » channel_mute channel_mute[] \ 是 none »» name string \ 是 Designer UI 上显示的通道名称 »» value string [on,off] 是 none 返回值： 无 备注 请求示例 POST /centralcontrol/audio/channel/mute { "channel_mute": [ { "name": "Dante-Input-1", "value": "on" }, { "name": "Dante-Input-2", "value": "off" }, ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 35）. 获取设备通道mute状态(已弃用，建议用36) 基本信息 Method： GET Path： /centralcontrol/audio/channel-mute 支持机型 NS 请求参数： Body: 名称 类型 必选 约束 说明 » channel_mute body [string] 是 \ »» name string 是 none Designer UI 上显示的通道名称 »» status string true [off, on] none 返回值： 无 备注 请求示例 GET /centralcontrol/audio/channel-mute { "channel_mute": [ "Dante-Input-1", "Dante-Input-0" ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "channel_mute": [ { "name": "Dante-Input-1", "status": "on" }, { "name": "Dante-Input-0", "status": "off" }, ] } 36）. 获取设备通道mute状态 基本信息 Method： GET Path： /centralcontrol/audio/channel/mute 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 channel_mute channel_mute[] \ 否 空参数是，默认获取所有input和output通道的mute的状态 channel_mute: 名称 类型 取值范围 是否必须 参数说明 name string \ none Designer UI 上显示的通道名称 status string \ [off, on] none 返回值： 无 备注 请求示例 GET /centralcontrol/audio/channel/mute { "channel_mute": [ "Dante-Input-1", "Dante-Input-0" ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "channel_mute": [ { "name": "Dante-Input-1", "status": "on" }, { "name": "Dante-Input-0", "status": "off" }, ] } 37）. 获取通道音量 基本信息 Method: GET Path: /centralcontrol/channel/volume 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 arr_gain_info string[] \ 是 通道名称。获取通道音量必须带通道名称，如果想获取所有通道音量要带所有的通道名称。接口本质上和通道增益是一个底层概念，音量只是对增益进行转换。 返回值： 名称 类型 取值范围 参数说明 arr_gain_info arr_gain_info[] \ \ arr_gain_info: 名称 类型 取值范围 参数说明 name string \ 通道名称 value int [0-100] 通道音量 备注： 请求示例： GET /centralcontrol/audio/channel/volume { "arr_gain_info": [ "Dante-Input-1", "Dante-Input-0" ] } 响应示例： HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "arr_gain_info": [ { "name": "Dante-Input-1", "value": "10" }, { "name": "Dante-Input-0", "value": "50" }, ] } 38）. 设置通道音量 基本信息： Method: POST Path: /centralcontrol/channel/volume 支持机型 NS 请求参数 Body 名称 类型 是否必须 取值范围 参数说明 arr_gain_info arr_gain_info[] 是 \ \ arr_gain_info: 名称 类型 取值范围 参数说明 name string \ 通道名称 value int [0-100] 通道音量 返回值 无 备注 请求示例 GET /centralcontrol/audio/channel/volume { "arr_gain_info": [ "Dante-Input-1", "Dante-Input-0" ] } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "arr_gain_info": [ { "name": "Dante-Input-1", "value": "10" }, { "name": "Dante-Input-0", "value": "50" }, ] } 3. 摄像头控制 1）. 摄像头移动 基本信息 Method: POST Path: /centralcontrol/camera/move 支持机型 Yealink RoomConnect，UVC40，UVC85, UVC86, SmartVision 40, AVHub, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、UVC设备和SmartVision设备不需要携带sn参数 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 direction string [up,down,left,right,stop] 是 摄像头移动方向up：控制摄像头方向向上改变down:控制摄像头方向向下改变left：控制摄像头方向向左改变right：控制摄像头方向向右改变stop：控制摄像头停止改变 sn string 无 否 摄像头唯一标识说明：如果指令请求时带了sn参数，代表控制的是指定sn的设备，否则控制的是摄像机列表第一个设备。 返回值： 无 备注 请求示例 POST /centralcontrol/camera/move { "direction": "up", "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 2）. 摄像头焦距 基本信息 Method: POST Path: /centralcontrol/camera/zoom 支持机型 Yealink RoomConnect，UVC40，UVC85, UVC86，SmartVision 40, AVHub, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、UVC设备和SmartVision设备不需要携带sn参数 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 direction string [in,out,stop] 是 摄像头焦距方向in：放大out：缩小stop：控制摄像头停止改变 sn string \ 否 摄像头唯一标识注意：如果指令请求时带了sn参数，代表控制的是指定sn的设备，否则控制的是摄像机列表第一个设备 返回值： 无 备注 请求示例 POST /centralcontrol/camera/zoom { "direction": "in", "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 3）. 获取摄像头位置 基本信息 Method： GET Path： /centralcontrol/camera/position 支持机型 Yealink RoomConnect，UVC40，UVC85,UVC86，SmartVision 40, AVHub, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、UVC设备和SmartVision设备不需要携带sn参数 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string \ 否 摄像头唯一标识说明：如果指令请求时带了sn参数，代表获取的是指定sn的设备，否则获取的是摄像机列表第一个设备。 返回值： 名称 类型 取值范围 参数说明 x double 参考范围：[0~3360] 存在机型差异，以实际获取为准 x轴坐标说明：受焦距值限制 y double 参考范围：[0~1890] 存在机型差异，以实际获取为准 y轴坐标说明：受焦距值限制 z double 参考范围：[-1890~0] 存在机型差异，以实际获取为准 焦距 备注 请求示例 GET /centralcontrol/camera/position { "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "x":1050.5, "y":500, "z":-280 } } 4）. 设置摄像头位置 基本信息 Method: POST Path: /centralcontrol/camera/position 支持机型 Yealink RoomConnect，UVC40，UVC85, UVC86，SmartVision 40，AVHub, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、UVC设备和SmartVision设备不需要携带sn参数3、SmartVision 40是电子摄像头，设置的位置不能任意指定，必须使用获取过的摄像头位置来设（比如预设置位应用场景） 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string \ 否 摄像头唯一标识说明：如果指令请求时带了sn参数，代表获取的是指定sn的设备，否则获取的是摄像机列表第一个设备。 x double 参考范围：[0~3360] 存在机型差异，以实际获取为准 是 x轴坐标说明：受焦距值限制，入参为double类型，即使是整数值也需要带小数点，否则无法成功执行。 y double 参考范围：[0~1890] 存在机型差异，以实际获取为准 是 y轴坐标说明：受焦距值限制，入参为double类型，即使是整数值也需要带小数点，否则无法成功执行。 z double 参考范围：[-1890~0] 存在机型差异，以实际获取为准 是 焦距说明：入参为double类型，即使是整数值也需要带小数点，否则无法成功执行。 返回值： 无 备注 请求示例 POST /centralcontrol/camera/position { "x":1050.0, "y":500.0, "z":-280.0, "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 5）. 获取摄像头列表 基本信息 Method: GET Path: /centralcontrol/camera/list 支持机型 Yealink RoomConnect，AVHub 请求参数： Body: 无 返回值： 名称 类型 参数说明 sn-list string 摄像头sn列表 备注 请求示例 GET /centralcontrol/camera/list { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "sn-list":["803032E070000031"] } } 6）. 获取摄像头详细信息 基本信息 Method: GET Path: /centralcontrol/camera/detail 支持机型 Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string 无 是 摄像头唯一标识 返回值： 名称 类型 参数说明 ip string 摄像头ip mac string 摄像头mac地址 name string 摄像头名称 firmware string 摄像头软件版本 hardware string 摄像头硬件版本 spec string 摄像头规格 model string 摄像头机型 sn string 摄像头sn 备注 请求示例 GET /centralcontrol/camera/detail { "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "ip":"169.254.1.150", "mac":"80:5E:C0:60:00:62", "name":"Yealink UVC84 -1", "firmware":"262.302.5.5", "hardware":"262.0.96.0.0.0.0", "spec":"PTZ 12x Optical Zoom", "model":"UVC84", "sn":"506607D117000009" } } 7）. 设置摄像头AI模式 基本信息 Method: POST Path: /centralcontrol/camera/ai-mode 支持机型 Yealink RoomConnect，UVC40，UVC85,UVC86，SmartVision 40，AVHub, SmartVision 80注意：1、Yealink RoomConnect使用该指令sn为必带参数2、UVC40设备不需要携带sn参数，UVC40仅支持"ptz，auto-frame，speaker-tracking"模式3、UVC86设备不需要携带sn参数，仅支持"ptz，auto-frame，speaker-tracking, multi-screen, presenter-tracking"模式4、SmartVision 40设备不需要携带sn参数，SmartVision 40仅支持"ptz，auto-frame，speaker-tracking, multi-screen, intellifocus, virtual-background, multi-stream-intelliframe"模式5、AVHub需要携带sn参数，仅支持"ptz，auto-frame，speaker-tracking, multi-screen, presenter-tracking"模式6、UVC85设备不需要携带sn参数，UVC86仅支持"ptz，auto-frame，speaker-tracking, multi-stream-intelliframe"模式7、SmartVision 80设备不需要携带sn参数，SmartVision 80仅支持"ptz，auto-frame，speaker-tracking, multi-screen, presenter-tracking, intellifocus"模式 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 type string [ptz,auto-frame,speaker-tracking,view-cropping,multi-screen,smart-gallery,pip,multi-pip,presenter-tracking,intellifocus,virtual-background,multi-stream-intelliframe] 是 模式类型ptz：手动控制auto-frame：自动框景speaker-tracking：语音追踪view-cropping：视角裁剪multi-screen：多分屏smart-gallery：智能画廊/多流模式pip：画中画multi-pip：多分屏+画中画presenter-tracking：跟拍模式intellifocus：多发言者跟踪virtual-background：虚拟背景multi-stream-intelliframe：多流intelliframe sn string 无 否 摄像头唯一标识说明：如果指令请求时带了sn参数，代表获取的是指定sn的设备，否则获取的是摄像机列表第一个设备。 返回值： 无 备注 请求示例 POST /centralcontrol/camera/ai-mode { "type": "ptz", "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 8）. 预设位应用 基本信息 Method： POST Path： /centralcontrol/camera/preset/recall 支持机型 Yealink RoomConnect，AVHub，UVC85，UVC86, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、UVC设备和SmartVision设备不需要携带sn参数 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 id int [1~99] 是 预设位标识AVHub和UVC86设备支持的预设置位的取值范围为[1~9] sn string \ 否 摄像头唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/camera/preset/recall { "id": 1, "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 9）. 预设位设置 基本信息 Method： POST Path： /centralcontrol/camera/preset 支持机型 Yealink RoomConnect，AVHub，UVC85，UVC86, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、UVC设备和SmartVision设备不需要携带sn参数 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 id int [1~99] 是 预设位标识AVHub和UVC86设备支持的预设置位的取值范围为[1~9] sn string \ 否 摄像头唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/camera/preset { "id": 1, "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 10）. 不休眠模式开关 基本信息 Method: POST Path: /centralcontrol/camera/keep-alive/switch 支持机型 Yealink RoomConnect 说明：YRC使用该指令sn为必带参数。 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 不休眠模式状态on：打开off：关闭 sn string \ 否 摄像头唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/camera/keep-alive/switch { "status: "on", "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 11）. 视频墙开关 基本信息 Method: POST Path: /centralcontrol/camera/video-fence/switch 支持机型 Yealink RoomConnect 说明：YRC使用该指令sn为必带参数。 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 视频墙状态on：打开off：关闭 sn string 无 否 摄像头唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/camera/video-fence/switch { "status: "on", "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 12）. 设置多摄跟踪功能 基本信息 Method: POST Path: /centralcontrol/camera/multi-camera-tracking-function 支持机型 AVHub,Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 type string [close,multi-camera-intellifocus,mic-camera-linkage,multi-stream-intelliframe,multi-camera-speaker-tracking] 是 模式类型close：关闭multi-camera-intellifocus：多发言者跟踪mic-camera-linkage：麦摄联动multi-stream-intelliframe：intelliFramemulti-camera-speaker-tracking：单发言者跟踪 返回值： 无 备注 请求示例 POST /centralcontrol/camera/multi-camera-tracking-function { "type": "multi-camera-intellifocus" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 13）. 读取摄像头使用状态 基本信息 Method： GET Path: /centralcontrol/camera/status 支持机型 SmartVision 40 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 status string [available,in_used] 摄像头使用状态： available:没有在使用 in_used:在被使用 备注 请求示例 GET /centralcontrol/camera/status { } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200, "data": { "status": "in_used" } } 14）. 识别读取Video Fence开关状态 基本信息 Method： GET Path: /centralcontrol/camera/video-fence-enable 支持机型 SmartVision 40 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 status string [on,off] 视频墙状态： on:开启 off:关闭 备注 请求示例 GET /centralcontrol/camera/video-fence-enable { } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200, "data": { "value": "on" } } 15）. 读取AI People Count 的人数 基本信息 Method： GET Path: /centralcontrol/camera/people-count 支持机型 SmartVision 40 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 quantity int [-1, 非负整数] -1:关闭状态 非负整数：开启状态识别到的人数 备注 请求示例 GET /centralcontrol/camera/people-count { } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200, "data": { "quantity": 1 } } 16）. 读取摄像头参数 基本信息 Method： GET Path: /centralcontrol/camera/video-parameter 支持机型 SmartVision 40 请求参数： Body: 无 返回值： 名称 参数类型 参数范围 说明 brightness int value[0,100] or -1(nosupport) SmartVision 40支持返回value staturation int value[0,100] or [0,10] SmartVision 40:[0,100] contrast int value[0,100] or -1(nosupport) SmartVision 40支持返回value whiteBalance int value[2800,6800] or -1(nosupport) 只有是手动白平衡的模式才会返回value whiteBalanceMode string [AutoWhiteBalance,ManualWhiteBalance,OnePush, Incandescent,Fluorescent,Daylight,CloudyDaylight,Shade] SmartVision 40支持AutoWhiteBalance,ManualWhiteBalance,OnePush sharp int [0-31] SmartVision 40范围为[0-31] 备注 请求示例 GET /centralcontrol/camera/video-parameter { } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200, "data": { "whiteBalance": 3610, "whiteBalanceMode": "ManualWhiteBalance", "contrast": 50, "brightness": 50, "saturation": 50, "sharpness": 19 } } 17）. 设置活动摄像头 基本信息 Method： POST Path： /centralcontrol/camera/active 支持机型 AVHub 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string \ 否 摄像头唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/camera/active { "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 4. 显示控制 1）. 获取屏幕亮度 基本信息 Method： GET Path： /centralcontrol/screen/brightness 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 id int 无 否 屏幕id(取值于获取设备列表信息的设备标识) 返回值： 名称 类型 取值范围 参数说明 value int [1~100] 屏幕亮度值 备注 请求示例 GET /centralcontrol/screen/brightness { "id":0 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "value":60 } } 2）. 设置屏幕亮度 基本信息 Method： POST Path： /centralcontrol/screen/brightness 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 id int 无 否 屏幕id(取值于获取设备列表信息的设备标识)，CTP25，RoomPanel E2等只有一个屏幕的，默认填0即可 value int [1~100] 是 屏幕亮度值 返回值： 无 备注 请求示例 POST /centralcontrol/screen/brightness { "id":0, "value":60 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 3）. 获取信号源列表 基本信息 Method： GET Path： /centralcontrol/input-source/list 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 备注 input-source-list source_list[] \ 输入源列表 source_list 名称 类型 备注 type string 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 备注 请求示例 GET /centralcontrol/input-source/list { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "input-source-list": [ { "type": "Default" }, { "type": "Android" }, { "type": "Windows" }, { "type": "HdmiIn" }, { "type": "TypeC" } ] } } 4）. 获取当前信号源 基本信息 Method： GET Path： /centralcontrol/input-source/current 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 type string 仅支持获取屏幕源列表取到输入源信息内容 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 备注 请求示例 GET /centralcontrol/input-source/current { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "type": "Default" } } 5）. 设置当前信号源 基本信息 Method： POST Path： /centralcontrol/input-source/current 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 type int 仅支持获取屏幕源列表取到输入源信息内容 是 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 返回值： 无 备注 请求示例 POST /centralcontrol/input-source/current { "type": "Windows" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 6）. 获取开机默认信号源 基本信息 Method： GET Path： /centralcontrol/input-source/default 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 是否必须 参数说明 type int 仅支持获取屏幕源列表取到输入源信息内容 是 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 备注 请求示例 GET /centralcontrol/input-source/default { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "type": "Windows" } } 7）. 设置开机默认信号源 基本信息 Method： POST Path： /centralcontrol/input-source/default 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 type int 仅支持获取屏幕源列表取到输入源信息内容 是 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 返回值： 无 备注 请求示例 POST /centralcontrol/input-source/default { "type": "windows" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 8）. 获取显示参数 基本信息 Method： GET Path： /centralcontrol/screen/display-parameter 支持机型 NS 请求参数： 名称 类型 取值范围 是否必须 参数说明 id int \ 否 屏幕id(取值于获取设备列表信息的设备标识),默认为0 Body: 无 返回值： 名称 类型 取值范围 参数说明 contrast int [1~100] 屏幕对比值 saturation int [1~100] 屏幕饱和值 color-temperature int [0~3] 色温0：暖色调1：默认2：冷色调3：自定义 备注 请求示例 GET /centralcontrol/screen/display-parameter { "id": 0 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "contrast": 60， "saturation": 60， "color-temperature": 0 } } 9）. 获取色温信息列表 基本信息 Method： GET Path： /centralcontrol/screen/color-temperature/info 支持机型 NS 请求参数： 名称 类型 取值范围 是否必须 参数说明 id int \ 否 屏幕id(取值于获取设备列表信息的设备标识),默认为0 Body: 无 返回值： 名称 类型 取值范围 备注 color-temperature-list color_temperature_list [] \ 色温信息列表 color_temperature_list 名称 类型 备注 value int 色温模式 name string 色温名称 备注 请求示例 GET /centralcontrol/screen/color-temperature/info { "id": 0 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "color-temperature-list": [ { "value":0, "name":"warm" }, { "value":1, "name":"default" }, { "value":2, "name":"cold" }, { "value":3, "name":"custom" } ] } } 10）. 设置显示参数 基本信息 Method： POST Path： /centralcontrol/screen/display-parameter 支持机型 NS 请求参数： Body: 名称 类型 取值范围 参数说明 id int 无 屏幕id(取值于获取设备列表信息的设备标识),默认为0 contrast int [1~100] 屏幕对比值 saturation int [1~100] 屏幕饱和值 color-temperature int [0~3] 色温0：暖色调1：默认2：冷色调3：自定义 返回值： 无 备注 请求示例 POST /centralcontrol/screen/display-parameter { "id":0, "contrast":68, "saturation":65, "color-temperature":3 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 11）. 重置显示参数 基本信息 Method： POST Path： /centralcontrol/screen/reset-display-parameter 支持机型 NS 请求参数： Body: 名称 类型 取值范围 参数说明 id int 无 屏幕id(取值于获取设备列表信息的设备标识),默认为0 返回值： 无 备注 请求示例 POST /centralcontrol/screen/reset-display-parameter { "id":0 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 12）. 设置自定义色温 基本信息 Method： POST Path： /centralcontrol/screen/color-temperature/custom 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 id int \ 否 屏幕id(取值于获取设备列表信息的设备标识),默认为0 red int [0~255] 是 红色温值 green int [0~255] 是 绿色温值 blue int [0~255] 是 蓝色温值 返回值： 无 备注 请求示例 POST /centralcontrol/screen/color-temperature/custom { "id":0, "red":128, "green":116, "blue":131 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 5. 多模控制 1）. 获取会议平台列表 基本信息 Method： GET Path： /centralcontrol/meeting-platform/mode-list 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 mode-list string 参考范围：[ume,yms,zoom,general,tencent,feishu,byod] 设备的会议平台列表ume：ume会议yms：yms会议zoom：zoom会议general：Yealink会议tencent：腾讯会议feishu：飞书byod：外设模式 备注 请求示例 GET /centralcontrol/meeting-platform/mode-list { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "mode-list":["ume","yms","zoom"] } } 2）. 设置会议平台 基本信息 Method： POST Path： /centralcontrol/meeting-platform 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 type string 参考范围：[ume,yms,zoom,general,tencent,feishu,byod] 是 设备安装的会议平台ume：ume会议yms：yms会议zoom：zoom会议general：Yealink会议tencent：腾讯会议feishu：飞书byod：外设模式 返回值： 无 备注 请求示例 POST /centralcontrol/meeting-platform { "type": "ume" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 3）. 获取当前平台 基本信息 Method： GET Path： /centralcontrol/meeting-platform/current-mode 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 name string \ 当前平台名称 备注 请求示例 GET /centralcontrol/meeting-platform/current-mode { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "name":"zoom" } } 6. 无线控制 1）. 设置蓝牙开关 基本信息 Method： POST Path： /centralcontrol/bluetooth 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 蓝牙状态off：关闭on：开启 返回值： 无 备注 请求示例 POST /centralcontrol/bluetooth { "status": "on" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 7. 摄像机布局控制 1）. 设置摄像机布局状态 基本信息 Method： POST Path： /centralcontrol/camera-layout/switch 支持机型 Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 摄像机布局状态on：启用off：禁用 返回值： 无 备注 请求示例 POST /centralcontrol/camera-layout/switch { "status": "on" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 2）. 设置摄像机布局类型 基本信息 Method： POST Path： /centralcontrol/camera-layout/type 支持机型 Yealink RoomConnect说明： 1.Yealink RoomConnect支持的type参数取值范围为fullscreen，div2~div9，1x1~1x8，pip；设置fullscreen模式时，需要配合 设置摄像机布局摄像机位置功能 指定位置为0的摄像机来应用fullscreen模式。2. small-screen-position，small-screen-size，main-screen-type,second-screen-type四个参数均针对画中画布局生效。3. 仅Yealink RoomConnect支持sn参数。 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 type string [fullscreen,div2~div9,1x1~1x8,1xN,divide,pip] 是 布局类型fullscreen：单方全屏布局div2~div9：二分屏~九分屏布局divide：等分布局 1xN：1+N布局1x1~1x8：1+1~1+8布局pip：画中画布局 sn string \ 否 子摄像机sn唯一标识（仅YRC支持） focus-camera string \ 否 布局中大图画面摄像机sn唯一标识（仅VCS设备支持） pip-param object \ 否 画中画相关参数集 >>small-screen-position string [top-left,bottom-left,top-right,bottom-right] 否 小画面位置（仅YRC支持）top-left：左上bottom-left：左下top-right：右上bottom-right：右下 说明：仅画中画布局设置有效。 >>small-screen-size string [one-fourth,one-ninth] 否 小画面尺寸（仅YRC支持）one-fourth：四分之一one-ninth：九分之一 说明：仅画中画布局设置有效。 >>main-screen-type string [panorama,close-up] 否 主镜头画面类型（仅YRC支持）panorama：全景画面close-up：特写画面说明：仅画中画布局设置有效。 >>second-screen-type string [panorama,auto-frame] 否 次镜头画面类型（仅YRC支持）panorama：全景画面auto-frame：自动框人像 说明：仅画中画布局设置有效。 返回值： 无 备注 YRC请求示例 POST /centralcontrol/camera-layout/type { "type": "fullscreen", "sn":"8703018090000132", "pip-param": { "small-screen-position":"top-left", "small-screen-size":"one-fourth", "main-screen-type":"panorama",         "second-screen-type":"auto-frame" } } VCS设备请求示例 POST /centralcontrol/camera-layout/type { "type": "fullscreen", "focus-camera": "8703018090000132" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 3）. 设置摄像机布局摄像机位置(MVC设备) 基本信息 Method： POST Path： /centralcontrol/camera-layout/position 支持机型 AVHub 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 position-list object \ 是（AVHub） 摄像机列表参数 >> sn \ 是（AVHub） 摄像头唯一标识 >> left [0~1920] 是（AVHub） 摄像头布局画面显示位置左坐标 >> top [0~1080] 是（AVHub） 摄像头布局画面显示位置顶部坐标 >> width [0~1920] 是（AVHub） 摄像头布局画面显示的宽度 >> height [0~1080] 是（AVHub） 摄像头布局画面显示的高度 返回值： 无 备注 请求示例 POST /centralcontrol/camera-layout/position { "position-list":[ { "sn":"806009E070000512", "left":0, "top":134, "width":1440, "height":810 }, { "sn":"806007D120000442", "left":1440, "top":134, "width":480, "height":270 } ] } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 4）. 设置摄像机布局摄像机位置（YRC） 基本信息 Method： POST Path： /centralcontrol/camera-layout/position 支持机型 Yealink RoomConnect注意：1、设置摄像机布局类型时，需要配合 设置摄像机布局摄像机位置功能 指定某个位置的摄像机来应用布局模式 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string \ 是 摄像头唯一标识 position int [0~8] 是 位置标识 返回值： 无 备注 请求示例 POST /centralcontrol/camera-layout/position { "sn":"8703018090000132", "position": 4 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 布局位置遵循从左到右顺序，以等分与1+N的最大数量为参考： 等分： 1+N： 5）. 获取摄像机布局类型 基本信息 Method： GET Path： /centralcontrol/camera-layout/type 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 type string [fullscreen,1xN,divide] 布局类型fullscreen：单方全屏布局divide：等分布局 1xN：1+N布局 focus-camera string \ 布局中大图画面摄像机sn唯一标识 备注 请求示例 GET /centralcontrol/camera-layout/type { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "type":"fullscreen", "focus-camera":"8703018090000132" } } 8. app控制 1）. 打开app到前台 基本信息 Method： POST Path： /centralcontrol/app/start 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 id string 参考基础信息文档接口获取app信息列表中的 id 值 是 app包名 activity string app指定的activity（界面） 否 app activity 返回值： 无 备注 如启动byod app：id=com.yealink.projection，activity=com.yealink.ui.projection.byod.BYODLauncher 请求示例 POST /centralcontrol/app/start { "id": "com.yealink.projection", "activity":"com.yealink.ui.projection.byod.BYODLauncher" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 参数错误： { "status":400 } 2）. 获取前台app 基本信息 Method： GET Path： /centralcontrol/app/foreground 支持机型 NS 请求参数： Body: 无 返回值： 名称类型备注idstringapp包名namestringapp名称versionstringapp版本号 请求示例 GET /centralcontrol/app/foreground { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "id":"com.yealink.byod", "name":"BYOD", "version":"1.0" } } 3）安装新的应用程序 基本信息 Method： POST Path： /centralcontrol/app/install 支持机型 NS 请求参数 Body: 名称 参数类型 取值范围 说明 path string NA 应用程序的安装地址，本地地址或者https地址 返回值 无 备注 在白名单内包名的应用才可以安装 请求示例 POST /centralcontrol/app/install { "path":"http://10.56.23.164/CentralControl.apk" } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 4）卸载应用程序 基本信息 Method： POST Path： /centralcontrol/app/uninstall 支持机型 NS 请求参数 Body: 名称 参数类型 取值范围 说明 packageName string NA 要卸载应用的包名，只支持卸载手动安装的app flags int {0,1,2} 0:一般删除1:删除app，保留data目录2:删除app和所有用户数据 返回值 无 备注 请求示例 POST /centralcontrol/app/uninstall { "packageName":"com.example.test", "flags":0 } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 9. 接口权限 1）. 获取物理接口列表 基本信息 Method： GET Path： /centralcontrol/phiysical-interface/list 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 type string \ 是 接口类别ALL：全部类别AUDIO：音频接口VIDEO：适配接口OTHRES：其他接口 返回值： 名称 类型 取值范围 备注 interface-list interface_list [] \ 设备信息列表 interface_list 名称 类型 备注 id int 接口id name string 接口名称 type string 接口类别AUDIO：音频接口VIDEO：适配接口OTHRES：其他接口 connected bool 接口连接状态true：已连接false：未连接 status string 接口状态on：打开off：关闭 备注 请求示例 GET /centralcontrol/phiysical-interface/list { "type":"ALL" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "interface-list": [ { "id":0, "name":"VCH", "type":"VIDEO", "connceted":true, "status":"on" }, { "id":0, "name":"LINE_IN", "type":"AUDIO", "connceted":false, "status":"on" } ] } } 2）. 设置物理接口开关 基本信息 Method： POST Path： /centralcontrol/phiysical-interface/enable 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 name string \ 是 接口名称 id int \ 是 实际获取接口id status string [on,off] 是 接口状态on：打开off：关闭 返回值： 无 备注 请求示例 ""POST /centralcontrol/phiysical-interface/enable { "name": "VCH", "id": 0, "status": "on" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 10. 其他 1）. 遥控器按键操作 基本信息 Method： POST Path： /centralcontrol/button 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 key string [power,F1,F2,F3,volume+,volume-,zoom+,zoom-,up,down,right,left,select,mute,back,call,delete,hangup,0~9*#] 是 遥控器按键名 返回值： 无 备注 请求示例 POST /centralcontrol/button { "key": "left" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 2）. 设置可分割会议室状态 基本信息 Method： POST Path： /centralcontrol/splitroom/status 支持机型 Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string \ 是 请求方身份标识 value int [0~3] 是 可分割会议室状态0：关闭可分割会议室功能 说明：在AVHub已经互相连接且开启可分割会议室功能的情况下，如果需要分割/合并房间，请在YRC上对具体的房间执行分割/合并，不要直接关闭可分割会议室功能。如果关闭可分割会议室功能，需要断开连接在AVHub CodeC口的线缆。1：可分割会议室下独立模式2：可分割会议室下被合并房间3：可分割会议室下主控房间 返回值： 无 备注 请求示例 POST /centralcontrol/splitroom/status { "sn":"8703018090000132", "value": 0 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 3）.设置可分割会议室 基本信息 Method: POST Path: /centralcontrol/division-room/config 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 room_info room_info [] \ 是 将房间分割成几个房间 room_info 名称 类型 取值范围 是否必须 参数说明 room_id int [] 元素范围：[1,3] 是 房间内包含的id，不可重复 返回值： 无 备注： 请求示例 POST /centralcontrol/division-room/config { "room_info":[ { "room_id":[ 1, 2 ] }, { "room_id": [ 3 ] } ] } 说明：将房间分为2个，第一个房间包括1、2两个最小可分割房间，第二个房间包括3 一个最小可分割房间。 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 4）.获取分割会议室状态 基本信息 Method: GET Path: /centralcontrol/division-room/config 支持机型 NS 请求参数： Body: 无 返回值： 名称 类型 取值范围 是否必须 参数说明 room_info room_info [] \ 是 将房间分割成几个房间 room_info 名称 类型 取值范围 是否必须 参数说明 room_id int [] 元素范围：[1,3] 是 房间内包含的id，不可重复 备注： 请求示例 GET /centralcontrol/division-room/config { } 响应示例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "room_info":[ { "room_id":[ 1 ] }, { "room_id":[ 2 ] }, { "room_id":[ 3 ] } ] } } 健康服务 监控设备健康状态，能提供告警机制 1. 设置日志服务器地址 基本信息 Method： POST Path： /centralcontrol/system/log-server 支持机型 UVC40注意：1、当关闭日志服务器时，可以不输入其他参数，否则必须携带参数2、建议使用参数：facility(16)，level(6)，transport-type(0) 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 enable int [0,1] 是 日志服务器功能开关1：启用 0：关闭 facility int [0-23] 是 日志存储设备 0: 内核消息1: 用户消息 2: 邮件系统3: 系统守护进程 4: 安全/授权消息5: 系统内部生成信息 6: 打印子系统7: 网络消息子系统 8: UUCP子系统9: 时钟守护进程 10: 安全/授权消息11: FTP守护进程 12: NTP子系统 13: 日志审计 14: 日志警告15: 时钟守护进程 16: 本地使用017: 本地使用1 18: 本地使用2 19: 本地使用3 20: 本地使用421: 本地使用5 22: 本地使用6 23: 本地使用7 level int [1-7] 是 日志等级 transport-type int [0,1,2] 是 传输类型 0: UDP1: TCP2: TLS port int \ 是 端口 server string \ 是 同步日志的服务器地址 返回值： 无 备注 请求示例 POST /centralcontrol/system/log-server { "enable": 1, "server":"syslog.test.yealink.com", "port":514, "facility":1, "level":6, "transport-type":0 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 2. 获取系统日志 基本信息 Method： GET Path： /centralcontrol/diagnostics/log 支持机型 Yealink RoomConnect 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 文件流 file \ （需主动触发下载才可获取到文件） 备注 请求示例 GET /centralcontrol/diagnostics/log { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 file 3. 网络诊断 基本信息 Method： POST Path： /centralcontrol/diagnostics/network 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 action string pingtraceroute 是 ping执行语句：ping -c num iptraceroute执行语句：traceroute -m num -I ip num int 1~30 是 ping次数；或traceroute跟踪的最大跳数 ip string \ 是 目标ip/域名 返回值： 名称 类型 取值范围 参数说明 result string \ 执行语句返回内容 备注 请求示例 POST /centralcontrol/diagnostics/network { "action": "ping", "num": 5, "ip": "10.50.150.1", } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "result": "PING 10.50.150.146 (10.50.150.146) 56(84) bytes of data. 64 bytes from 10.50.150.146: icmp_seq=1 ttl=64 time=0.164 ms 64 bytes from 10.50.150.146: icmp_seq=2 ttl=64 time=0.087 ms 64 bytes from 10.50.150.146: icmp_seq=3 ttl=64 time=0.091 ms --- 10.50.150.146 ping statistics --- 3 packets transmitted, 3 received, 0% packet loss, time 2051ms rtt min/avg/max/mdev = 0.087/0.114/0.164/0.035 ms" } } 参数错误： { "status":400 } 4. 开启或停止抓包文件上传 基本信息 Method： POST Path： /centralcontrol/diagnostics/packetcapture 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 filter string 可过滤ip、port、协议等 否 过滤条件 interface string wan：当前活跃网卡 start操作时必须 接口名称 filter-type int 0：自定义1：SIP or H245 or H2252：RTP3：Not RTP start操作时必须 过滤类型；如果值为 0，则 filter 生效 operation string start：开始抓包stop：停止抓包get：获取抓包文件 是 抓包动作；stop、get时，无需携带以上三个参数注：1、建议开始抓包之后，每5分钟左右发送get指令获取抓包文件，抓包文件需自行拼接（可能会获取到空文件，因为此时设备端仍未生成文件）；超过十分钟未get，则视为放弃最近抓包文件，抓包停止2、stop时设备端响应最近未上传文件 返回值： 文件： 名称 类型 取值范围 参数说明 抓包文件 file \ 响应get/stop操作；上传抓包文件本身，无文件类型后缀 备注 请求示例 POST /centralcontrol/diagnostics/packetcapture 自定义过滤抓包开始： { "filter": "tcp", "interface": "wan", "filter-type": 0, "operation": "start" } 指定过滤条件抓包开始： { "filter": "", "interface": "wan", "filter-type": 2, "operation": "start" } 获取抓包文件： { "operation": "get" } 停止抓包： { "operation": "stop" } 响应实例 start操作时，成功开始抓包响应： HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, } get/stop操作时，设备端已生成文件并发送： HTTP/1.1 200 OK Content-Type: application/octet-stream file 5. 告警 基本信息 Method： GET Path： /centralcontrol/diagnostics/alert 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 severity string critical：严重major：主要minor：一般all：全部 否 若未指定severity，则默认为critical from-time long 单位：秒；最早时间点为7天前 否 1、响应from-time到指令发送时间点之间的告警事件列表2、若未指定from-time，默认响应近十分钟告警事件列表3、该时间戳是指某一时刻与"1970年1月1日00:00:00" UTC 时间点之间经历的秒数 返回值： 名称 类型 取值范围 备注 alert-list alert_list [] \ 设备信息列表 alert_list 名称 类型 取值范围 参数说明 name string Dsk slave disconnect：配件断连Update Configuration failure：配置文件更新失败Update Firmware failure：固件升级失败Wireless microphone low battery：无线麦低电量 事件名称 severity string critical：严重major：主要minor：一般 \ action-time long 单位：秒 告警时间戳 mac string \ 设备mac地址 ip string \ 设备ip地址 备注 请求示例 GET /centralcontrol/diagnostics/alert { "severity": "major", "from-time": 1701138336 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "alert-list": [ { "name": "Update Configuration failure", "severity": "major", "action-time": 1701138336, "mac": "00:00:00:00:00:00", "ip": "10.50.15.1" }, { "name": "Dsk slave disconnect", "severity": "critical", "action-time": 1701138336, "mac": "00:00:00:00:00:00", "ip": "10.50.15.1" } ] } } 更新服务 更新设备本身以及周边配件的固件 1. 设备升级 基本信息 Method： POST Path： /centralcontrol/upgrade/firmware/start 支持机型 Yealink RoomConnect 注意：1、Yealink RoomConnect至少填写sn和device其中一个参数2、sn与device理论上只填一种，同时填写，只生效sn参数 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string \ 否 升级的设备sn device string \ 否 升级的设备类型 url string \ 是 升级的固件地址(url地址或本地路径) time int -1~23 否 升级时间-1：立即升级0~23：升级时间 返回值： 无 备注 请求示例 POST /centralcontrol/upgrade/firmware/start { "sn":"803032E070000031", "url": "https://packet-nexus.yealink.com/service/rest/repository/browse/repo-packet-release/AllRom/MeetingEye500-rom/280.321.0.17/MeetingEye500-280.321.0.17.rom", "time":-1 } POST /centralcontrol/upgrade/firmware/start { "device":"UVC86", "url": "https://packet-nexus.yealink.com/service/rest/repository/browse/repo-packet-release/AllRom/MeetingEye500-rom/280.321.0.17/MeetingEye500-280.321.0.17.rom", "time":-1 } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 2. 设备取消升级 基本信息 Method： POST Path： /centralcontrol/upgrade/firmware/cancel 支持机型 Yealink RoomConnect 注意： 1、sn与device理论上只填一种，同时填写，只生效sn参数 2、sn与device都不填时，取消全部升级3.设备升级过程中无法取消 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string \ 否 停止升级的设备sn device string \ 否 升级的设备类型 返回值： 无 备注 请求示例 POST /centralcontrol/upgrade/firmware/cancel { "sn":"803032E070000031" } POST /centralcontrol/upgrade/firmware/cancel { "deivce":"UVC84" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 3. 获取升级状态 基本信息 Method： GET Path： /centralcontrol/upgrade/firmware/status 支持机型 Yealink RoomConnect 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string \ 是 获取升级状态的设备sn 返回值： 名称 类型 取值范围 参数说明 status string [downloading,upgrading,success,fail] 下载状态：downloading：下载中upgrading：升级中 success：成功fail：失败 progress int 0~100 升级进度，仅升级中返回正常值，否则为-1 备注 请求示例 GET /centralcontrol/upgrade/firmware/status { "sn":"803032E070000031" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "status":"upgrading", "progress": 48 } } 配置服务 1. 配置文件更新 本操作可提供 Wi-Fi开关/无线热点开关/蓝牙开关 等一系列开关的配置更新（注意：通话中不能进行配置文件更新操作） 基本信息 Method： POST Path： /centralcontrol/config/update 支持机型 NS 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 url string 如果为空，触发autop默认更新 是 配置文件地址（autop更新地址） 返回值： 无 备注 请求示例 POST /centralcontrol/config/update { "url": "http://1.1.1.1/test.cfg" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 200 } 设备繁忙： { "status": 400 }