中控环境基本说明（指令） 目的 本文通过对该中控控制API指令的功能说明和语法的详细介绍，使阅读人员能够快速了解中控控制模块的相关功能，并能指导开发人员完成后续的开发编码工作。能够根据说明完成与yealink VCS 产品的网络模式的控制主机的开发。 简介 2.1 网络模式配置说明 设备支持网络模式对主机设备进行控制，采用 TCP 协议建立连接，客户端需要知道主机的ip地址和端口号才能连接主机端。 以下是网络模式需要配置的参数： 1> 中控的网络模式的控制端口配置为：6024 2> ip 地址可以根据实际情况查看即可 3> 如果中控的网络模式开启了密码鉴权，通过TCP协议建立连接时，需要输入密码并鉴权通过后，才能正常执行中控指令。输入密码格式为 "XXXX\r\n" ，其中XXXX为正确的密码。 例如：建立 TCP 连接后，收到"Password:\r\n"信息，即提示需要输入鉴权密码。 当前输入错误的密码，连接会返回"Invalid Password!\r\nPassword:\r\n"，提示需要重新输入密码进行鉴权。 只要输入正确的密码，连接会返回"welcome yealink centralcontrol"。 2.2 串口模式配置说明 部分设备支持串口模式对主机设备进行控制，例如：M500和M900。客户端需要通过串口线连接到主机设备，主机正常识别到串口，采用串口协议建立连接。 串口的波特率、数据位、奇偶校验位和结束位可以通过设备的网页进行配置。 API指令 3.1 API 基本语法说明 本介绍设备中控API指令说明文件，为了便于说明 API 指令语法，对API书写的格式做如下声明与约定： 指令单词均为小写 指令基本结构：命令+参数 参数组成：参数名+参数值 ------ 以：号分隔，指令参数总体同httpapi格式，以json字串形式传输 注意："app"为特殊参数，区别于其他参数，独立在json格式外传输，此参数代表指令调用的是app的指令，不带该参数默认为系统层指令 3.2 基本数据包格式说明 发送格式说明： 采用\r\n （回车换行符）作为结束标识符 所有API 指令发送最后都需要加入\r\n结束的标识符 返回格式说明：采用\r\n作为结束标识符 所有返回包都会带有\r\n的结束标识符 指令基本格式： Command + \r\n（无参数类型） Command + 空格 + json字符串 + \r\n（带参数类型） Command + 空格 + app:value + 空格 + json字符串 + \r\n（带参数及app参数类型） 3.2 API指令详细说明 目前支持的API指令列表如下文所述，请读者参考指令说明，在调试时，可以使用tcp调试工具，根据上文的环境支持说明进行搭建，测试API命令。不同版本与机型支持的命令和参数会有差异。 以下API指令参数中以"[]"包含的为可选参数。 系统层指令 前言：以下指令说明中，"[]"的请求参数均代表为选填项，指令入参维持json字符串格式，像名字之类的涉及中文的，必须要用utf8格式的字符。 system语法 1. 获取系统版本信息 返回参数 名称 类型 参数说明 model string 设备机型 firmware string 软件版本号 hardware string 硬件版本号 serialnumber string 设备sn号 macaddress string 设备mac地址 cc-version string 中控版本号 说明 system 指令 system get version 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50，UVC40 发送格式 system get version\r\n 返回格式 system get version {"model":"MeetingEye 500","firmware":"280.320.254.125","hardware":"280.0.0.0.0.0.0","macaddress":"00:15:65:00:00:00","serialnumber":"506607D117000009","cc-version":"1.0.0.2"}\r\n 示例 Send：system get version \r\nReturn: system get version {"model":"MeetingEye 500","firmware":"280.320.254.125","hardware":"280.0.0.0.0.0.0","macaddress":"00:15:65:00:00:00","serialnumber":"506607D117000009","cc-version":"1.0.0.2"} \r\n 2. 获取系统状态 返回参数 名称 类型 取值范围 参数说明 status string [sleeping,wake-up] 系统状态sleeping：休眠wake-up：唤醒 说明 system 指令 system get status 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 system get status\r\n 返回格式 system get status {"status":"sleeping"}\r\n 示例 Send：system get status \r\nReturn: system get status {"status":"sleeping"} \r\n 3. 设置系统状态 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [sleeping,wake-up,reboot,reset] 是 系统状态sleeping：休眠wake-up：唤醒reboot：重启reset：恢复出厂 sn string 无 否 设备唯一标识sn 说明 system 指令 system set status {"status":"<value>",["sn":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，UVC40， SmartVision 40AP08，AVBridge，CM20，CM50，CS10，CS10-D注意：1、Yealink RoomConnect/UVC40仅支持重启，恢复出厂2、仅Yealink RoomConnect支持传sn参数3、SmartVision 40支持重启4、AP08，AVBridge，CM20，CM50，CS10，CS10-D支持重启和恢复出厂 发送格式 system set status {"status":"wake-up",["sn":"506607D117000009"]} \r\n 返回格式 system set status {"status":"wake-up",["sn":"506607D117000009"]} \r\n 示例 带sn情况： Send：system set status {"status":"wake-up","sn":"506607D117000009"} \r\nReturn: system set status {"status":"wake-up","sn":"506607D117000009"} \r\n 不带sn情况：Send：system set status {"status":"wake-up"} \r\nReturn: system set status {"status":"wake-up"} \r\n 4. 设置日志服务器地址 请求参数 名称 类型 取值范围 是否必须 参数说明 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: 本地使用0 17: 本地使用1  18: 本地使用2  19: 本地使用3  20: 本地使用4 21: 本地使用5 22: 本地使用6  23: 本地使用7 level int [1-7] 是 日志等级 transport-type int [0,1,2] 是 传输类型 0: UDP 1: TCP 2: TLS port int 无 是 端口 server string 无 是 同步日志的服务器地址 说明 system 指令 system set log-server {"enable":<value>,"facility":<value>,"level":<value>,"transport-type":<value>,"port":<value>,"server":"<value>"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50，UVC40注意：1、当关闭日志服务器时，可以不输入其他参数，否则必须携带参数2、建议使用参数：facility(16)，level(6)，transport-type(0) 发送格式 system set log-server {"enable": 1,"server":"syslog.test.yealink.com", "port":514, "facility":1,  "level":6,"transport-type":2} \r\n 返回格式 system set log-server {"enable": 1,"server":"syslog.test.yealink.com", "port":514, "facility":1,  "level":6,"transport-type":2} \r\n 示例 Send：system set log-server {"enable": 1,"server":"syslog.test.yealink.com", "port":514,"facility":1, "level":6,"transport-type":2}\r\n Return: system set log-server {"enable": 1,"server":"syslog.test.yealink.com", "port":514, "facility":1,  "level":6,"transport-type":2}\r\n 5. 获取设备列表 返回参数 名称 类型 取值范围 备注 device-list device_info [] 无 设备信息列表 device_info 名称 类型 备注 model string 设备类型 firmware string 固件版本号 hardware string 硬件版本号 serialnumber string 设备sn号 macaddress string 设备mac地址 id int 设备标识（可用于设置或获取屏幕参数） 说明** system 指令 system get devices 支持机型 Yealink RoomConnect，SmartVision 40，MeetingEye 500/900 发送格式 system get devices \r\n 返回格式 system get devices {"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",  },  {  "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": 0 }  ]  }\r\n 示例 Send：system get devices \r\nReturn: system get devices {"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",  },  {  "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": 0 }  ]  } \r\n 6. 获取工作时间 返回参数 名称 类型 取值范围 参数说明 value int >0 工作时长（以分钟为单位） 说明 system 指令 system get uptime 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50，SmartVision 40 发送格式 system get uptime\r\n 返回格式 system get uptime{"value":840}\r\n 示例 Send：system get uptime\r\nReturn: system get uptime{"value":840} \r\n 7. 获取CPU信息 返回参数 名称 类型 取值范围 参数说明 cpu-usage int [1~100] cpu占用率（以百分之一为单位） cpu-temp int [-10,100] cpu温度，单位：℃ 说明 system 指令 system get cpu-info 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50, SmartVision 40 说明：1、SmartVision40支持cpu-temp 发送格式 system get cpu-info\r\n 返回格式 system get cpu-info{"cpu-usage":25}\r\n 示例 Send：system get cpu-info\r\nReturn: system get cpu-info{"cpu-usage":25} \r\n **SmartVision 40:**Send: system get cpu-info\r\nReturn:``system get cpu-info {"cpu-usage":11,"cpu-temp":69}\r\n 8.获取系统硬件信息 返回参数 名称 类型 参数说明 model string 设备机型 firmware string 软件版本号 hardware string 硬件版本号 serialnumber string 设备sn号 macaddress string 设备mac地址 cc-version string 中控版本号 vendor string 设备厂商名称 说明 system 指令 system get sys-info 支持机型 SmartVision 40 发送格式 system get sys-info\r\n 返回格式 system get sys-info {"model":"SmartVision40","firmware":"286.0.253.1068","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"} 示例 Send:<br> system get sys-info <br> Return:<br> system get sys-info{"model":"SmartVision40","firmware":"286.0.253.1068","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"}\r\n 9. 读取usb接口连接状态 返回参数 名称 类型 取值范围 说明 status string [on,off] 连接状态：on:已连接off:未连接 说明 system指令 system get pc-connect-status 支持机型 SmartVision 40 发送格式 system get pc-connect-status\r\n 返回格式 system get pc-connect-status {"status":"on"}\r\n 示例 Send：system get pc-connect-status\r\nReturn:``system get pc-connect-status {"status":"on"}\r\n 10. 读取内存信息 返回参数 名称 类型 取值范围 说明 memory-usage int [0,100] 内存使用率 total-memory int >0 总内存，单位Mb free-memory int >=0 未使用内存，单位Mb used-memory int >0 已使用内存，单位Mb 说明 sytem指令 system get memory-info 支持机型 Smartvision 40 发送格式 system get memory-info\r\n 返回格式 system get memory-info {"memory-usage":20,"total-memory":953,"free-memory":758,"used-memory":195}\r\n 示例 Send:<br>system get memory-info\r\n Return:system get memory-info {"memory-usage":20,"total-memory":953,"free-memory":758,"used-memory":195}\r\n 11. 读取设备状态 返回参数 名称 类型 取值范围 说明 normal string [true,false] 设备是否正常 normal = !(memorytoohigh|| cpuusagetoohigh) memorytoohigh string [true,false] 内存占用是否过高,默认大于80返回true cpuusagetoohigh string [true,false] cpu占用是否过高,默认大于80返回true 说明 system指令 system get alert-status 支持机型 SmartVision 40 发送格式 system get alert-status\r\n 返回格式 system get alert-status {"normal":"true","memorytoohigh":"false","cpuusagetoohigh":"false"}\r\n 示例 Send:system get alert-status\r\nReturn:``system get alert-status {"normal":"true","memorytoohigh":"false","cpuusagetoohigh":"false"}\r\n 12. 设置告警信息规则 请求参数 参数 类型 取值范围 说明 cpu int [0,100] 设置cpu过高的阈值，单位：%，默认为80，请求参数为取值范围之外的数值时，设置为默认值 memory int [0,100] 设置memory过高的阈值，单位：%，默认为80，请求参数为取值范围之外的数值时，设置为默认值 说明 system指令 system set alert-rules {"cpu":90,"memory":70} 支持机型 SmartVision 40 发送格式 system set alert-rules {"cpu":90,"memory":70}\r\n 返回格式 system set alert-rules {"cpu":90,"memory":70}\r\n 示例 Send：system set alert-rules {"cpu":90,"memory":70}\r\nReturn:``system set alert-rules {"cpu":90,"memory":70}\r\n 13. 获取当下时间 返回参数 参数 类型 取值范围 说明 value int NA linux时间戳 说明 system指令 system get current-time 支持机型 SmartVision 40 发送格式 system get current-time\r\n 返回格式 system get current-time {"value":1725459796}\r\n 示例 Send：system get current-time\r\nReturn:``:system get current-time {"value":1725459796}\r\n 14. 获取硬件信息 返回参数 名称 类型 取值范围 参数说明 » hardware_list body [object] 是 »» type body string 是 »» index body [string] 否 说明 system 指令 system get hardware 支持机型 AP08 发送格式 system get hardware{"hal_list": [{"type": "<value>","mode": "<value>","index": [<value>]}]}\r\n 返回格式 system get hardware{"hal_list":[{"type":"<value>","mode":"<value>","status":[{"index":<value>,"status":"<value>"}]}]}\r\n 示例 Send：system get hardware{"hal_list":[{"type":"gpio","mode":"input","index":[1,2]}]}\r\nReturn: system get hardware{"hal_list":[{"type":"gpio","mode":"input","status":[{"index":1,"status":"high"},{"index":2,"status":"low"}]}]}\r\n 15. 获取BYOD-EXTENDER的状态 返回参数 名称 类型 取值范围 说明 status string [available,in_use, disconnected, unknown] USB连接状态：available: MVC-BYOD-Extender连接主机，但未使用in_use: MVC-BYOD-Extender使用中disconnected: MVC-BYOD-Extender未连接unknown: 未知状态 说明 system 指令 byod get extender-status 支持机型 Yealink RoomConnect 发送格式 byod get extender-status {"sn":"806009F040000357"}\r\n 返回格式 byod get extender-status {"status":"unknown"}\r\n 示例 Send：byod get extender-status {"sn":"806009F040000357"}\r\nReturn: byod get extender-status {"status":"unknown"}\r\n 16. 设置设备定位开关 请求参数 名称 类型 取值范围 是否必须 参数说明 status string {on,off} 是 on:打开设备定位off:关闭设备定位 说明 system指令 system set locating-status 支持机型 AP08，AVBridge，CM20，CM50，CS10，CS10-D 发送格式 system set locating-status {"status": "on"}\r\n 返回格式 system set locating-status {"status": "on"}\r\n 示例 Send:system set locating-status {"status": "on"}\r\nReturn:system set locating-status {"status": "on"}\r\n 17. 设置LED灯开关 请求参数 名称 类型 取值范围 是否必须 参数说明 enable string {on, off} 是 on: 打开LED灯off: 关闭LED灯注意：打开及关闭的都是对应事件的LED灯 说明 system指令 system set led-preset-status 支持机型 CM20、CM50、CS10、CS10-D 发送格式 system set led-preset-status {"enable": "on"}\r\n 返回格式 system set led-preset-status {"enable": "on"}\r\n 示例 Send:system set led-preset-status {"enable": "on"}\r\nReturn:system set led-preset-status {"enable": "on"}\r\n 18. 获取LED灯开关状态 返回参数 名称 类型 取值范围 参数说明 enable string {on,off} on:开启状态off:关闭状态 说明 system指令 system get led-preset enable 支持机型 CM20、CM50、CS10、CS10-D 发送格式 system get led-preset enable\r\n 返回格式 system get led-preset enable {"enbale":"off"}\r\n 示例 Send:system get led-preset enable\r\nReturn:system get led-preset enable {"enbale":"off"}\r\n 19. 设置LED灯事件的颜色 请求参数 名称 类型 取值范围 是否必须 参数说明 event string {mute,unmute} 是 灯事件 color string {red，green，orange，#xxxxxx} 是 对应事件的灯的颜色 说明 system system set led-preset config 支持机型 CM20、CM50、CS10、CS10-D 发送格式 system set led-preset config {"event":"mute", "color":"red"}\r\n 返回格式 system set led-preset config {"event":"mute", "color":"red"}\r\n 示例 Send:system set led-preset config {"event":"mute", "color":"red"}\r\nReturn:system set led-preset config {"event":"mute", "color":"red"}\r\n 20. 获取LED灯事件的颜色 请求参数 名称 类型 取值范围 是否必须 参数说明 event string {mute, unmute} 是 要获取灯颜色的事件 返回参数 名称 类型 取值范围 参数说明 event string {mute, unmute} - color string {red, green, orange,#xxxxxx} 灯的颜色 说明 system语法 system get led-preset config 支持机型 CM20、CM50、CS10、CS10-D 发送格式 system get led-preset config {“event":"unmute"}\r\n 返回格式 system get led-preset config {“event":"unmute","color":"#856974"}\r\n 示例 Send:system get led-preset config {“event":"unmute"}\r\nReturn:system get led-preset config {“event":"unmute","color":"#856974"}\r\n button语法 1. 遥控器按键操作 请求参数 名称 类型 取值范围 是否必须 参数说明 key string [power,F1,F2,F3,volume+,volume-,zoom+,zoom-,up,down,right,left,select,mute,back,call,delete,hangup,0~9*#] 是 遥控器按键名 说明 button 指令 button {"key": "<value>"} 支持机型 MeetingEye 500，UVC40,SamrtVision 40注意：1、UVC40机型仅支持volume+和volume-2、SmartVision 40仅支持volume+和volume- 发送格式 button {"key":"power"}\r\n 返回格式 button {"key":"power"}\r\n 示例 Send：button {"key":"power"} \r\n Return: button {"key":"power"} \r\n camera语法 1. 控制摄像头移动 请求参数 名称 类型 取值范围 是否必须 参数说明 direction string [up,down,left,right,stop] 是 摄像头移动方向up：控制摄像头方向向上改变down:控制摄像头方向向下改变left：控制摄像头方向向左改变right：控制摄像头方向向右改变stop：控制摄像头停止改变 sn string 无 否 摄像头唯一标识注意：如果指令请求时带了sn参数，代表控制的是指定sn的设备，否则控制的是摄像机列表第一个设备 说明 camera 指令 camera move {"direction":"<value>",["sn":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，UVC40， UVC85， UVC86, SmartVision 40, AVHub, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数 发送格式 camera move {"direction":"up",["sn":"506607D117000009"]} \r\n 返回格式 camera move {"direction":"up",["sn":"506607D117000009"]} \r\n 示例 带sn参数情况： Send：camera move {"direction":"up","sn":"506607D117000009"} \r\n Return: camera move {"direction":"up","sn":"506607D117000009"} \r\n 不带sn参数情况： Send：camera move {"direction":"up"} \r\n Return: camera move {"direction":"up"} \r\n 2. 控制摄像头焦距 请求参数 名称 类型 取值范围 是否必须 参数说明 direction string [in,out,stop] 是 摄像头焦距方向in：放大out：缩小stop：控制摄像头停止改变 sn string 无 否 摄像头唯一标识注意：如果指令请求时带了sn参数，代表控制的是指定sn的设备，否则控制的是摄像机列表第一个设备 说明 camera 指令 camera zoom {"direction":"<value>",["sn":"<value>"]} 功能说明 控制摄像头焦距 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，UVC40， UVC85，UVC86, SmartVision 40, AVHub, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数 发送格式 camera zoom {"direction":"in",["sn":"506607D117000009"]} \r\n 返回格式 camera zoom {"direction":"in",["sn":"506607D117000009"]} \r\n 示例 带sn参数情况： Send：camera zoom {"direction":"in","sn":"506607D117000009"} \r\n Return: camera zoom {"direction":"in","sn":"506607D117000009"} \r\n不带sn参数情况： Send：camera zoom {"direction":"in"} Return: camera zoom {"direction":"in"} \r\n 3. 获取摄像头位置 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 否 摄像头唯一标识注意：如果指令请求时带了sn参数，代表获取的是指定sn的设备，否则获取的是摄像机列表第一个设备 返回参数 名称 类型 取值范围 参数说明 x double 参考范围：[0~3360] 存在机型差异，以实际获取为准 x轴坐标注意：受焦距值限制 y double 参考范围：[0~1890] 存在机型差异，以实际获取为准 y轴坐标注意：受焦距值限制 z double 参考范围：[-1890~0] 存在机型差异，以实际获取为准 焦距 说明 camera 指令 camera get position {["sn":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，UVC40， UVC85， UVC86，SmartVision 40, AVHub, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数 发送格式 camera get position {["sn":"506607D117000009"]} r\n 返回格式 camera get position {"x":1910.0,"y":1060.0,"z":50.5}\r\n 示例 带sn参数情况： Send：camera get position {"sn":"506607D117000009"} \r\n Return: camera get position {"x":1910.0,"y":1060.0,"z":50.5} \r\n不带sn参数情况： Send：camera get position \r\n Return: camera get position {"x":1910.0,"y":1060.0,"z":50.5} \r\n 4. 设置摄像头位置 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 否 摄像头唯一标识注意：如果指令请求时带了sn参数，代表获取的是指定sn的设备，否则获取的是摄像机列表第一个设备 x double 参考范围：[0~3360] 存在机型差异，以实际获取为准 是 x轴坐标注意：受焦距值限制，入参为double类型，即使是整数值也需要带小数点，否则无法成功执行 y double 参考范围：[0~1890] 存在机型差异，以实际获取为准 是 y轴坐标注意：受焦距值限制，入参为double类型，即使是整数值也需要带小数点，否则无法成功执行 z double 参考范围：[-1890~0] 存在机型差异，以实际获取为准 是 焦距注意：入参为double类型，即使是整数值也需要带小数点，否则无法成功执行 说明 camera 指令 camera set position {"x":<value>,"y":<value>,"z":<value>,["sn":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，UVC40， UVC85，UVC86, SmartVision 40, AVHub, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数 发送格式 camera set position {"x":1910.0,"y":1060.0,"z":50.5,["sn":"506607D117000009"]} r\n 返回格式 camera set position {"x":1910.0,"y":1060.0,"z":50.5,["sn":"506607D117000009"]} \r\n 示例 带sn参数情况： Send：camera set position {"x":1910.0,"y":1060.0,"z":50.5,"sn":"506607D117000009"} \r\n Return: camera set position {"x":1910.0,"y":1060.0,"z":50.5,"sn":"506607D117000009"} \r\n不带sn参数情况： Send：camera set position {"x":1910.0,"y":1060.0,"z":50.5} \r\n Return: camera set position {"x":1910.0,"y":1060.0,"z":50.5} \r\n 5. 获取摄像头列表 返回参数 名称 类型 参数说明 sn-list string 摄像头sn列表 说明 camera 指令 camera get list 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect, AVHub 发送格式 camera get list\r\n 返回格式 camera get list {"sn-list":["803032E070000031"]} \r\n 示例 Send：camera get list \r\n Return: camera get list {"sn-list":["803032E070000031"]} \r\n 6. 获取摄像头详细信息 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 是 摄像头唯一标识 返回参数 名称 类型 参数说明 ip string 摄像头ip mac string 摄像头mac地址 name string 摄像头名称 firmware string 摄像头软件版本 hardware string 摄像头硬件版本 spec string 摄像头规格 model string 摄像头机型 sn string 摄像头sn 说明 camera 指令 camera get detail {"sn":"<value>"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect 发送格式 camera get detail {"sn":"506607D117000009"} r\n 返回格式 camera get detial {"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":"8703018090000132"}\r\n 示例 Send：camera get detail {"sn":"506607D117000009"} \r\n Return: camera get detial {"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":"8703018090000132"} \r\n 7. 设置摄像头AI模式 请求参数 名称 类型 取值范围 是否必须 参数说明 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的设备，否则获取的是摄像机列表第一个设备 说明 camera 指令 camera set ai-mode {"type":"<value>",["sn":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，UVC40， UVC85，UVC86，SmartVision 40, AVHub, SmartVision 80注意：1、Yealink RoomConnect使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数，A10仅支持"ptz, auto-frame, speaker-tracking, view-cropping, multi-screen, pip"模式3、MeetingBoard 65/86/75-Pro，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数；如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作4、UVC40设备不需要携带sn参数，UVC40仅支持"ptz，auto-frame，speaker-tracking"模式5、MeetingEye 500接入UVC86设备后支持的模式为"ptz，auto-frame，speaker-tracking，smart-gallery，presenter-tracking"、接入UVC84设备支持"ptz，auto-frame"模式6、MeetingBoard 65/86支持"ptz，auto-frame，speaker-tracking，multi-screen，pip，smart-gallery，presenter-tracking"模式7、UVC86设备不需要携带sn参数，UVC86仅支持"ptz，auto-frame，speaker-tracking, multi-screen, presenter-tracking"模式8、SmartVision 40设备不需要携带sn参数，SmartVision 40仅支持"ptz，auto-frame，speaker-tracking, multi-screen, intellifocus, virtual-background, multi-stream-intelliframe"模式9、AVHub需要携带sn参数，仅支持"ptz，auto-frame，speaker-tracking, multi-screen, presenter-tracking"模式10、UVC85设备不需要携带sn参数，UVC86仅支持"ptz，auto-frame，speaker-tracking, multi-stream-intelliframe"模式11、SmartVision 80设备不需要携带sn参数，SmartVision 80仅支持"ptz，auto-frame，speaker-tracking, multi-screen, presenter-tracking, intellifocus"模式 发送格式 camera set ai-mode {"type":"ptz",["sn":"506607D117000009"]} r\n 返回格式 camera set ai-mode {"type":"ptz",["sn":"506607D117000009"]} \r\n 示例 带sn参数情况： Send：camera set ai-mode {"type":"ptz","sn":"506607D117000009"} \r\n Return: camera set ai-mode {"type":"ptz","sn":"506607D117000009"} \r\n 不带sn参数情况： Send：camera set ai-mode {"type":"ptz"} \r\n Return: camera set ai-mode {"type":"ptz"} \r\n 8. 应用摄像机预设位 请求参数 名称 类型 取值范围 是否必须 参数说明 id int [1~99] 是 预设位标识AVHub和UVC86设备支持的预设置位的取值范围为[1~9] sn string 无 否 摄像头唯一标识 说明 camera 指令 camera recall preset {"id":<value>,["sn":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，AVHub，UVC85，UVC86, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数 发送格式 camera recall preset {"id":2,["sn":"8703018090000132"]} \r\n 返回格式 camera recall preset {"id":2,["sn":"8703018090000132"]} \r\n 示例 带sn参数情况： Send：camera recall preset {"id":2,"sn":"8703018090000132"} \r\n Return: camera recall preset {"id":2,"sn":"8703018090000132"} \r\n不带sn参数情况： Send：camera recall preset {"id":2} \r\n Return: camera recall preset {"id":2} \r\n 9. 设置摄像机预设位 请求参数 名称 类型 取值范围 是否必须 参数说明 id int [1~99] 是 预设位标识AVHub、UVC85、UVC86设备支持的预设置位的取值范围为[1~9] sn string 无 否 摄像头唯一标识 说明 camera 指令 camera set preset {"id":<value>,["sn":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，AVHub，UVC85，UVC86, SmartVision 80注意：1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数 发送格式 camera set preset {"id":2,["sn":"8703018090000132"]} \r\n 返回格式 camera set preset {"id":2,["sn":"8703018090000132"]} \r\n 示例 带sn参数情况： Send：camera set preset {"id":2,"sn":"8703018090000132"} \r\n Return: camera set preset {"id":2,"sn":"8703018090000132"} \r\n不带sn参数情况： Send：camera set preset {"id":2} \r\n Return: camera set preset {"id":2} \r\n 10. 不休眠模式开关 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 不休眠模式状态on：打开off：关闭 sn string 无 否 摄像头唯一标识 说明 camera 指令 camera keep-alive set switch {"status":<value>,"sn":<value>} 支持机型 Yealink RoomConnect注意：YRC使用该指令sn为必带参数 发送格式 camera keep-alive set switch {"status":"off","sn":"506011D110000054"}\r\n 返回格式 camera keep-alive set switch {"status":"off","sn":"506011D110000054"}\r\n 示例 Send：camera keep-alive set switch {"status":"off","sn":"506011D110000054"}\r\nReturn: camera keep-alive set switch {"status":"off","sn":"506011D110000054"}\r\n 11. 视频墙开关 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 视频墙状态on：打开off：关闭 sn string 无 否 摄像头唯一标识 说明 camera 指令 camera video-fence set switch {"status":<value>,"sn":<value>} 支持机型 Yealink RoomConnect，SmartVision 40注意：YRC使用该指令sn为必带参数;SmartVision 40无需带参数sn 发送格式 camera video-fence set switch {"status":"on","sn":"806009E070000512"}\r\n 返回格式 camera video-fence set switch {"status":"on","sn":"806009E070000512"}\r\n 示例 Send：camera video-fence set switch {"status":"on","sn":"806009E070000512"}\r\nReturn: camera video-fence set switch {"status":"on","sn":"806009E070000512"}\r\n 12. 设置多摄跟踪功能 请求参数 名称 类型 取值范围 是否必须 参数说明 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：单发言者跟踪 说明 camera 指令 camera set multi-camera-tracking-function {"type":<value>} 支持机型 AVHub,Yealink RoomConnect 发送格式 camera set multi-camera-tracking-function {"type":"multi-camera-intellifocus"}\r\n 返回格式 camera set multi-camera-tracking-function {"type":"multi-camera-intellifocus"}\r\n 示例 Send：camera set multi-camera-tracking-function {"type":"multi-camera-intellifocus"}\r\nReturn: camera set multi-camera-tracking-function {"type":"multi-camera-intellifocus"}\r\n 13. 获取摄像头状态 返回参数 参数 类型 取值范围 说明 status string [available,in_use] 摄像头使用状态：available:没有在使用in_use:在被使用 说明 camera指令 camera get status 支持机型 SmartVison 40 发送格式 camera get status\r\n 返回格式 camera get status {"status":"in_use"}\r\n 示例 Send：camera get status\r\n Return:camera get status {"status":"in_use"}\r\n 14. 获取ai people count 的人数 返回参数 名称 类型 取值范围 说明 quantity int [-1,非负整数] -1:人数统计模式关闭非负整数：人数统计开启返回的人数 说明 camera指令 camera get people-count 支持机型 SmartVision 40 发送格式 camera get people-count\r\n 返回格式 camera get people-count {"quantity":1}\r\n 示例 Send：camera get people-count\r\nRetrun:``camera get people-count {"quantity":1}\r\n 15. 读取 video parameter 返回参数 名称 类型 取值范围 说明 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,<br>Incandescent,Fluorescent,Daylight,CloudyDaylight,Shade] SmartVision 40支持AutoWhiteBalance,ManualWhiteBalance,OnePush sharp int [0-31] SmartVision 40范围为[0-31] 说明 camera指令 camera get video-parameter 支持机型 SmartVision 40 发送格式 camera get video-paremeter\r\n 返回格式 camera get video-parameter {"whiteBalance":-1,"whiteBalanceMode":"AutoWhiteBalance","contrast":50,"brightness":50,"saturation":50,"sharpness":16}\r\n 示例 Send:<br>camera get video-parameter\r\n <br>Return:<br>camera get video-parameter {"whiteBalance":-1,"whiteBalanceMode":"AutoWhiteBalance","contrast":50,"brightness":50,"saturation":50,"sharpness":16}\r\n 16. 获取视频墙状态 返回参数 名称 类型 取值范围 说明 status string [on,off] 视频墙状态：on:开启 off：关闭 说明 camera指令 camera get people-count 支持机型 SmartVision 40 发送格式 camera get people-count\r\n 返回格式 camera get people-count {"quantity":1}\r\n 示例 Send：camera get people-count\r\nRetrun:``camera get people-count {"quantity":1}\r\n 17. 设置活动摄像头 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 否 摄像头唯一标识 说明 camera 指令 camera set active {"sn":"<value>"} 支持机型 MeetingBoard 65/86/75-Pro，MeetingEye 500/900, Avhub 发送格式 camera set active {"sn":"8703018090000132"}\r\n 返回格式 camera set active {"sn":"8703018090000132"}\r\n 示例 带sn参数情况： Send：camera set active {"sn":"8703018090000132"}\r\nReturn: camera set active {"sn":"8703018090000132"}\r\n screen语法 1. 获取屏幕亮度 请求参数 名称 类型 取值范围 是否必须 参数说明 id int 无 否 屏幕id(取值于获取设备列表信息的设备标识) 返回参数 名称 类型 取值范围 参数说明 value int [1~100] 屏幕亮度值 说明 screen 指令 screen get brightness 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay 发送格式 screen get brightness {"id":0}\r\n 返回格式 screen get brightness {"value":50}\r\n 示例 Send：screen get brightness {"id":0}\r\n Return: screen get brightness {"value":50} \r\n 2. 设置屏幕亮度 请求参数 名称 类型 取值范围 是否必须 参数说明 id int 无 否 屏幕id(取值于获取设备列表信息的设备标识) value int [1~100] 是 屏幕亮度值 说明 screen 指令 screen set brightness {"value":<value>} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay 发送格式 screen set brightness {"id":0, "value":80}\r\n 返回格式 screen set brightness {"id":0, "value":80}\r\n 示例 Send：screen set brightness {"id":0,"value":80} \r\n Return: screen set brightness {"id":0, "value":80} \r\n 3. 获取显示参数 请求参数 名称 类型 取值范围 是否必须 参数说明 id int 无 否 屏幕id(取值于获取设备列表信息的设备标识),默认为0 返回参数 名称 类型 取值范围 参数说明 contrast int [1~100] 屏幕对比值 saturation int [1~100] 屏幕饱和值 color-temperature int [0~3] 色温0：暖色调1：默认2：冷色调3：自定义 说明 screen 指令 screen get display-parameter 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay 发送格式 screen get display-parameter {"id": 0}\r\n 返回格式 screen get display-parameter {"contrast": 60,"saturation": 60,"color-temperature": 0}\r\n 示例 Send：screen get display-parameter {"id": 0}\r\n Return: screen get display-parameter {"contrast": 60,"saturation": 60,"color-temperature": 0} \r\n 4. 获取色温信息列表 请求参数 名称 类型 取值范围 是否必须 参数说明 id int 无 否 屏幕id(取值于获取设备列表信息的设备标识),默认为0 返回参数 名称 类型 取值范围 备注 color-temperature-list color_temperature_list [] 无 色温信息列表 color_temperature_list 名称 类型 备注 value int 色温模式 name string 色温名称 说明 screen 指令 screen get color-temperature-info 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay 发送格式 screen get color-temperature-info {"id": 0}\r\n 返回格式 screen get color-temperature-info {"color-temperature-list": [{"value":0, "name":"warm"},{"value":1, "name":"default"},{"value":2, "name":"cold"},{"value":3, "name":"custom"}]}\r\n 示例 Send：screen get color-temperature-info {"id": 0}\r\n Return: screen get color-temperature-info {"color-temperature-list": [{"value":0, "name":"warm"},{"value":1, "name":"default"},{"value":2, "name":"cold"},{"value":3, "name":"custom"}]}\r\n 5. 设置显示参数 请求参数 名称 类型 取值范围 参数说明 id int 无 屏幕id(取值于获取设备列表信息的设备标识),默认为0 contrast int [1~100] 屏幕对比值 saturation int [1~100] 屏幕饱和值 color-temperature int [0~3] 色温0：暖色调1：默认2：冷色调3：自定义 说明 screen 指令 screen set display-parameter {"value":<value>} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay 发送格式 screen set display-parameter {"id":0, "contrast": 60,"saturation": 60,"color-temperature": 0}\r\n 返回格式 screen set display-parameter {"id":0, "contrast": 60,"saturation": 60,"color-temperature": 0}\r\n 示例 Send：screen set display-parameter {"id":0, "contrast": 60,"saturation": 60,"color-temperature": 0} \r\n Return: screen set display-parameter {"id":0, "contrast": 60,"saturation": 60,"color-temperature": 0} \r\n 6. 重置显示参数 请求参数 名称 类型 取值范围 参数说明 id int 无 屏幕id(取值于获取设备列表信息的设备标识),默认为0 说明 screen 指令 screen reset display-parameter {"value":<value>} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay 发送格式 screen reset display-parameter {"id":0} \r\n 返回格式 screen reset display-parameter {"id":0} \r\n 示例 Send：screen reset display-parameter {"id":0} \r\n Return: screen reset display-parameter {"id":0}  \r\n 7. 设置自定义色温 请求参数 名称 类型 取值范围 是否必须 参数说明 id int 无 否 屏幕id(取值于获取设备列表信息的设备标识,默认为0 red int [0~255] 是 红色温值 green int [0~255] 是 绿色温值 blue int [0~255] 是 蓝色温值 说明 screen 指令 screen set custom-color-temperature {"red": <value>,"green": <value>,"blue": <value>} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay 发送格式 screen set custom-color-temperature {"id":0, "red": 128,"green": 116,"blue": 131}\r\n 返回格式 screen set custom-color-temperature {"id":0, "red": 128,"green": 116,"blue": 131}\r\n 示例 Send：screen set custom-color-temperature {"id":0, "red": 128,"green": 116,"blue": 131} \r\n Return: screen set custom-color-temperature {"id":0, "red": 128,"green": 116,"blue": 131} \r\n 8. 获取信号源列表 返回参数 名称 类型 取值范围 备注 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 输入 说明 screen 指令 input-source get list 支持机型 MeetingBoard 65/75/86 Pro, MeetingBoard 65/86, MeetingDisplay 发送格式 input-source get list \r\n 返回格式 input-source get list {"input-source-list":[{"type":"Android"},{"type":"HdmiIn 1"},{"type":"HdmiIn 2"},{"type":"HdmiIn 3"}]} \r\n 示例 Send：input-source get list \r\n Return: input-source get list {"input-source-list":[{"type":"Android"},{"type":"HdmiIn 1"},{"type":"HdmiIn 2"},{"type":"HdmiIn 3"}]} \r\n 9. 获取当前信号源 返回参数 名称 类型 备注 type string 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 说明 screen 指令 input-source get current 支持机型 MeetingBoard 65/75/86 Pro, MeetingBoard 65/86, MeetingDisplay 发送格式 input-source get current \r\n 返回格式 input-source get current {"type":"HdmiIn 1"} \r\n 示例 Send：input-source get current \r\n Return: input-source get current {"type":"HdmiIn 1"} \r\n 10. 设置当前信号源 请求参数 名称 类型 备注 type string 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 说明 screen 指令 input-source set current {"type": <value>} 支持机型 MeetingBoard 65/75/86 Pro, MeetingBoard 65/86, MeetingDisplay 发送格式 input-source set current {"type":"Android"} \r\n 返回格式 input-source set current {"type":"Android"} \r\n 示例 Send：input-source set current {"type":"Android"} \r\n Return: input-source set current {"type":"Android"} \r\n 11. 获取置开机默认信号源 返回参数 名称 类型 备注 type string 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 说明 screen 指令 input-source get default 支持机型 MeetingBoard 65/75/86 Pro, MeetingBoard 65/86, MeetingDisplay 发送格式 input-source get default \r\n 返回格式 input-source get default {"type":"HdmiIn 3"} \r\n 示例 Send：input-source get default \r\n Return: input-source get default {"type":"HdmiIn 3"} \r\n 12. 设置开机默认信号源 返回参数 名称 类型 备注 type string 屏幕输入源类型Default：默认输入Android：android系统Windows：windows系统HdmiIn：hdmi输入TypeC：typec输入HdmiIn 1：hdmi 1 输入HdmiIn 2：hdmi 2 输入HdmiIn 3：hdmi 3 输入 说明 screen 指令 input-source set default {"type": <value>} 支持机型 MeetingBoard 65/75/86 Pro, MeetingBoard 65/86, MeetingDisplay 发送格式 input-source set default {"type":"HdmiIn 1"} \r\n 返回格式 input-source set default {"type":"HdmiIn 1"} \r\n 示例 Send：input-source set default {"type":"HdmiIn 1"} \r\n Return: input-source set default {"type":"HdmiIn 1"} \r\n app语法 1. 获取前台app 返回参数 名称 类型 备注 id string app包名 name string app名称 version string app版本号 说明 system 指令 app get foreground 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 app get foreground\r\n 返回格式 app get foreground {"id":"com.yealink.byod","name":"BYOD","version":"1.0"}\r\n 示例 Send：app get foreground\r\nReturn: app get foreground {"id":"com.yealink.byod","name":"BYOD","version":"1.0"}\r\n 2. 获取app信息列表 返回参数 名称 类型 取值范围 备注 app-list app_list [] 无 设备信息列表 app_list 名称 类型 备注 id string app包名 name string app名称 version string app版本号 说明 system 指令 app info 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 app info\r\n 返回格式 app info {"app-list":[{"id":"com.yealink.byod","name":"BYOD","version":"2.0"},{"id":"us.zoom.zoompresence","name":"Zoom Rooms","version":"6.0.6.4892"}]}\r\n 示例 Send：app info\r\nReturn: app info {"app-list":[{"id":"com.yealink.byod","name":"BYOD","version":"2.0"},{"id":"us.zoom.zoompresence","name":"Zoom Rooms","version":"6.0.6.4892"}]}\r\n 3. 打开app到前台 请求参数 名称 类型 取值范围 是否必须 参数说明 id string 参考基础信息文档接口获取app信息列表中的 id 值 是 app包名 说明 system 指令 app start {"id":<value>} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 app start {"id":"com.yealink.byod"}\r\n 返回格式 app start {"id":"com.yealink.byod"}\r\n 示例 Send：app start {"id":"com.yealink.byod"}\r\nReturn: app start {"id":"com.yealink.byod"}\r\n audio 语法 1. 获取音频源列表 返回参数 名称 类型 参数说明 input-source string 输入源列表 output-source string 输出源列表 说明 audio 指令 audio get source-info 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 audio get source-info \r\n 返回格式 audio get source-info {"input-source":[],"output-source":["AUTO","HDMI"]}\r\n 示例 Send：audio get source-info \r\n Return: audio get source-info {"input-source":[],"output-source":["AUTO","HDMI"]} \r\n 2. 设置音频输入源 请求参数 名称 类型 取值范围 是否必须 参数说明 type string 仅支持获取音频源列表取到输入源信息内容 是 音频输入源标识ATUO：自动VCP：CP96X设备LINE：线性输入USB_LINE：USB转线性输入BUILT_IN: 内置麦HANDSET: 手柄BT_HANDSET: 蓝牙手柄WIRED_MIC：有线麦WIRELESS_MIC：无线麦XLR: 三针插口输入 说明 audio 指令 audio set input-source {"type":"<value>"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 audio set input-source {"type":"VCP"}\r\n 返回格式 audio set input-source {"type":"VCP"}\r\n 示例 Send：audio set input-source {"type":"VCP"} \r\n Return: audio set input-source {"type":"VCP"} \r\n 3. 设置音频输出源 请求参数 名称 类型 取值范围 是否必须 参数说明 type string 仅支持获取音频源列表取到输出源信息内容 是 音频输出源标识AUTO：自动VCP：CP96X设备HDMI：hdmiLINE：线性输出USB_LINE：USB转线性输出BUILT_IN：内置扬声器HEADSET: 耳机BT_HEADSET: 蓝牙耳机WIRED_SPEAKER：有线扬声器 说明 audio 指令 audio set output-source {"type":"<value>"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 audio set output-source {"type":"LINE"}\r\n 返回格式 audio set output-source {"type":"LINE"}\r\n 示例 Send：audio set output-source {"type":"LINE"} \r\n Return: audio set output-source {"type":"LINE"} \r\n 4. 获取音频静音状态（已弃用，建议用mic-mute） 返回参数 名称 类型 取值范围 参数说明 status string [on,off] 静音状态on：打开off：关闭 说明 audio 指令 audio get mute 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，UVC40，SmartVision 40 发送格式 audio get mute\r\n 返回格式 audio get mute {"status":"on"}\r\n 示例 Send：audio get mute \r\n Return: audio get mute {"status":"on"} \r\n 5. 设置音频静音状态（MVC机型） 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 静音状态on：打开off：关闭 说明 audio 指令 audio set mute {"status":"<value>"} 支持机型 UVC40，Yealink RoomConnect，SmartVision 40，AP08，AVBridge，CM20，CM50，CS10，CS10-D注意：1.AP08，AVBridge，CM20，CM50，CS10，CS10-D是设置设备所有通道mute状态，并且和单独获取设置通道mute的接口状态不同步。 发送格式 audio set mute {"status":"off"}\r\n 返回格式 audio set mute {"status":"off"}\r\n 示例 Send：audio set mute {"status":"off"} \r\n Return: audio set mute {"status":"off"} \r\n 6. 设置音频静音状态（VCS机型） 请求参数 名称 类型 取值范围 是否必须 参数说明 key string [mute] 是 按键名 说明 button 指令 button {"key": "mute"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 button {"key": "mute"}\r\n 返回格式 button {"key": "mute"}\r\n 示例 Send：button {"key": "mute"} \r\n Return: button {"key": "mute"} \r\n 7. 获取音量 请求参数 名称 类型 取值范围 是否必须 参数说明 type string [idle,talk] 否 音量类型idle：铃声音量talk：通话音量 返回参数 名称 类型 取值范围 参数说明 value int [0~15] 音量值 说明 audio 指令 audio get volume {["type":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50，UVC40，Yealink RoomConnect注意：1、UVC40设备请求该接口时不需要带参数2、MeetingBoard 65/86/MeetingEye 500可选填音量类型参数，默认为idle（单音量模式idle与talk音量会被同步） 发送格式 audio get volume {["type":"idle"]} \r\n 返回格式 audio get volume {"value":5}\r\n 示例 带type情况： Send：audio get volume {"type":"idle"} \r\n Return: audio get volume {"value":5} \r\n不带type情况： Send：audio get volume \r\n Return: audio get volume {"value":5} \r\n 8. 设置音量 请求参数 名称 类型 取值范围 是否必须 参数说明 value int [0~15] 是 音量值 type string [idle,talk] 否 音量类型idle：铃声音量talk：通话音量 说明 audio 指令 audio set volume {"value":<value>,["type":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect注意：1、MeetingBoard 65/86/MeetingEye 500可选填音量类型参数，默认为idle（单音量模式idle与talk音量会被同步） 发送格式 audio set volume {"value":5,["type":"idle"]} \r\n 返回格式 audio set volume {"value":5,["type":"idle"]} \r\n 示例 带type情况： Send：audio set volume {"value":5,"type":"idle"} \r\nReturn: audio set volume {"value":5,"type":"idle"} \r\n不带type情况： Send：audio set volume {"value":5}\r\nReturn: audio set volume {"value":5} \r\n 9. 设置输入音频降噪 请求参数 名称 类型 取值范围 是否必须 参数说明 ai-mode string [on,off] 否 AI智能降噪模式 <br>on：打开 <br>off：关闭 level int [0,1,2,3] 否 抑制等级 <br>0：关 <br>1：弱 <br>2：正常 <br>3：强 sn string 无 否 设备唯一标识 说明 audio 指令 audio input set noise-reduction {"sn":"<value>","ai-mode":"<value>","level":"<value>"} 支持机型 Yealink RoomConnect注意：1、ai-mode适用的机型：avhub，uvc84，uvc862、level适用的机型：avhub，uvc84，uvc86，vcm34，vcm35，vcm38，cm20 发送格式 audio input set noise-reduction {"sn":"506607D117000009","ai-mode":"on","level":2} \r\n 返回格式 audio input set noise-reduction {"sn":"506607D117000009","ai-mode":"on","level":2} \r\n 示例 Send：audio input set noise-reduction {"sn":"506607D117000009","ai-mode":"on","level":2} \r\n Return: audio input set noise-reduction {"sn":"506607D117000009","ai-mode":"on","level":2} \r\n 10. 设置输入音频增益 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 增益控制状态 <br>on：打开 <br>off：关闭 gain-value int [-30~30] 否 增益调节值 <br> rca-value int [-12~40] 否 RCA输入调节值 line-value int [-12~40] 否 Line输入调节值 attenuation-value int [-30~30] 否 衰减调节值 sn string 无 否 设备唯一标识 说明 audio 指令 audio input set gain {"status":"<value>","sn":"<value>","gain-value":"<value>","rca-value":"<value>","line-value":"<value>"} 支持机型 Yealink RoomConnect注意：1、rca-value与line-value参数仅对调节的设备是avhub生效 发送格式 audio input set gain {"status":"on","sn":"506011D110000054","gain-value":20,"rca-value":-6,"attenuation-value":20,"line-value":12} \r\n 返回格式 audio input set gain {"status":"on","sn":"506011D110000054","gain-value":20,"rca-value":-6,"attenuation-value":20,"line-value":12} \r\n 示例 Send：audio input set gain {"status":"on","sn":"506011D110000054","gain-value":20,"rca-value":-6,"attenuation-value":20,"line-value":12} \r\n Return: audio input set gain {"status":"on","sn":"506011D110000054","gain-value":20,"rca-value":-6,"attenuation-value":20,"line-value":12} \r\n 11. 设置输入音频回声消除 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 回声消除状态 <br>on：打开 <br>off：关闭 suppress-level int [0,1,2] 否 回声消除等级 <br>0：低 <br>1：中 <br>2：高 reverb-level int [0,1,2] 否 房间混响等级 <br>0：低 <br>1：中 <br>2：高 manual-dalay string [on,off] 否 手动延迟 <br>on：打开 <br>off：关闭 delay-value int [-100~500] 否 音频AEC延迟数 (单位：ms) sn string 无 否 设备唯一标识 说明 audio 指令 audio input set echo-cancellation {"status":"<value>","sn":"<value>","suppress-level":"<value>","reverb-level":"<value>","manual-dalay":"<value>","delay-value":"<value>"} 支持机型 Yealink RoomConnect 发送格式 audio input set echo-cancellation {"status":"on","sn":"506607D117000009","suppress-level":1,"reverb-level":0,"manual-dalay":"on","delay-value":200} \r\n 返回格式 audio input set echo-cancellation {"status":"on","sn":"506607D117000009","suppress-level":1,"reverb-level":0,"manual-dalay":"on","delay-value":200} \r\n 示例 Send：audio input set echo-cancellation {"status":"on","sn":"506607D117000009","suppress-level":1,"reverb-level":0,"manual-dalay":"on","delay-value":200} \r\n Return: audio input set echo-cancellation {"status":"on","sn":"506607D117000009","suppress-level":1,"reverb-level":0,"manual-dalay":"on","delay-value":200}\r\n 12. 设置输入音频均衡器 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 均衡器状态 <br>on：打开 <br>off：关闭 mode string [custom,bass-boost,<br>treble-boost,vocal-boost] 是 均衡器模式 <br>custom：自定义 <br>bass-boost：低音增强 <br>treble-boost：高音增强 <br>vocal-boost：人声增强 frequency-range-list int [-12~12] 否 自定义模式频段列表，列表数据分别对应：``20hz，63hz，125hz，250hz，500hz，1000hz，2000hz，4000hz，8000hz，20000hz sn string 无 否 设备唯一标识 说明 audio 指令 audio input set equalizer {"status":"<value>","sn":"<value>","mode":"<value>","frequency-range-list":"<value>"} 支持机型 Yealink RoomConnect注意：1、rca-value与line-value参数仅对调节的设备是avhub生效 发送格式 audio input set equalizer {"status":"on","sn":"506011D110000054","mode":"custom","frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]} \r\n 返回格式 audio input set equalizer {"status":"on","sn":"506011D110000054","mode":"custom","frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]} \r\n 示例 Send：audio input set equalizer {"status":"on","sn":"506011D110000054","mode":"custom","frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]} \r\n Return: audio input set equalizer {"status":"on","sn":"506011D110000054","mode":"custom","frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]} \r\n 13. 设置输出音频增益 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 增益控制状态 <br>on：打开 <br>off：关闭 gain-value int [-30~30] 否 增益调节值 <br> attenuation-value int [-30~30] 否 衰减调节值 line-value int [-50-30] 否 Line输出调节值 sn string 无 否 设备唯一标识 说明 audio 指令 audio output set gain {"status":"<value>","sn":"<value>","gain-value":"<value>"} 支持机型 Yealink RoomConnect注意：1、rca-value与line-value参数仅对调节的设备是avhub生效 发送格式 audio output set gain {"status":"on","sn":"506011D110000054","gain-value":20,"attenuation-value":18,"line-value":10} \r\n 返回格式 audio output set gain {"status":"on","sn":"506011D110000054","gain-value":20,"attenuation-value":18,"line-value":10} \r\n 示例 Send：audio output set gain {"status":"on","sn":"506011D110000054","gain-value":20,"attenuation-value":18,"line-value":10} \r\n Return: audio output set gain {"status":"on","sn":"506011D110000054","gain-value":20,"attenuation-value":18,"line-value":10} \r\n 14. 设置输出音频均衡器 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 均衡器状态 <br>on：打开 <br>off：关闭 mode string [custom,bass-boost,<br>treble-boost,vocal-boost] 是 均衡器模式 <br>custom：自定义 <br>bass-boost：低音增强 <br>treble-boost：高音增强 <br>vocal-boost：人声增强 frequency-range-list int [-12~12] 否 自定义模式频段列表，列表数据分别对应：``20hz，63hz，125hz，250hz，500hz，1000hz，2000hz，4000hz，8000hz，20000hz sn string 无 否 设备唯一标识 说明 audio 指令 audio output set equalizer {"status":"<value>","sn":"<value>","mode":"<value>","frequency-range-list":"<value>"} 支持机型 Yealink RoomConnect注意：1、rca-value与line-value参数仅对调节的设备是avhub生效 发送格式 audio output set equalizer {"status":"on","sn":"506011D110000054","mode":"custom","frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]} \r\n 返回格式 audio output set equalizer {"status":"on","sn":"506011D110000054","mode":"custom","frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]}\r\n 示例 Send：audio output set equalizer {"status":"on","sn":"506011D110000054","mode":"custom","frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]} \r\n Return: audio output set equalizer {"status":"on","sn":"506011D110000054","mode":"custom","frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]} \r\n 15. 获取mic静音状态 返回参数 名称 类型 取值范围 参数说明 status string [on,off] 静音状态on：打开off：关闭 说明 audio 指令 audio get mic-mute 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect，UVC40，SmartVision 40 发送格式 audio get mic-mute\r\n 返回格式 audio get mic-mute {"status":"on"}\r\n 示例 Send：audio get mic-mute \r\n Return: audio get mic-mute {"status":"on"} \r\n 16. 获取扬声器静音状态 返回参数 名称 类型 取值范围 参数说明 status string [on,off] 静音状态：on:打开off:关闭 说明 aduio指令 audio get speaker-mute 支持机型 SmartVision 40 发送格式 audio get speaker-mute\r\n 返回格式 audio get speaker-mute {"status":"off"}\r\n 示例 Send:audio get speaker-muteReturn:``audio get speaker-mute {"status":"off"} 17. 获取Aduio Fence（音频墙）的开关状态 返回参数 名称 类型 取值范围 说明 status string [on,off] 音频墙开关状态：on:开启 off:关闭 说明 audio指令 audio get fence-enable 支持机型 SmartVision 40 发送格式 audio get fence-enable\r\n 返回格式 audio get fence-enable {"status":"off"}\r\n 示例 Send:<br>audio get fence-enable\r\n <br>Return:<br>audio get fence-enable {"status":"off"}\r\n 18. 获取设备声源通道信息(已弃用，建议用19) 返回参数 名称 类型 取值范围 是否必须 参数说明 max_channel_count int - 是 最大通道数 channel_enable bool[] - 是 通道使能状态 说明 audio 指令 audio get device-sound-channel-info 支持机型 CM50 发送格式 audio get device-sound-channel-info \r\n 返回格式 audio get device-sound-channel-info{"max_channel_count":8,"channel_enable":[true,true,true,true,true,true,true,true]} \r\n 示例 Send：audio get device-sound-channel-info \r\nReturn: audio get device-sound-channel-info{"max_channel_count":8,"channel_enable":[true,true,true,true,true,true,true,true]} \r\n 19. 获取设备通道声源信息 返回参数 名称 类型 取值范围 是否必须 参数说明 max_channel_count int - 是 最大通道数 channel_enable bool[] - 是 通道使能状态 说明 audio 指令 audio get lobe-enable 支持机型 CM50 发送格式 audio get lobe-enable\r\n 返回格式 audio get lobe-enable {"max_channel_count":8,"channel_enable":[true,true,true,true,true,true,true,true]}\r\n 示例 Send：audio get lobe-enable\r\nReturn: audio get lobe-enable {"max_channel_count":8,"channel_enable":[true,true,true,true,true,true,true,true]}\r\n 20. 获取设备声源通道激活状态（已弃用，建议用21） 返回参数 名称 类型 取值范围 是否必须 参数说明 active_status bool[] 无 是 通道激活状态 说明 audio 指令 audio get device-sound-active-status 支持机型 CM50 发送格式 audio get device-sound-active-status\r\n 返回格式 audio get device-sound-active-status{"active_status":[true,true,true,true,true,true,true,true]} \r\n 示例 Send：audio get device-sound-active-status \r\nReturn: audio get device-sound-active-status{"active_status":[true,true,true,true,true,true,true,true]} \r\n 21. 获取设备声源通道激活状态 返回参数 名称 类型 取值范围 是否必须 参数说明 active_status bool[] 无 是 通道激活状态 说明 audio 指令 audio get lobe-activation 支持机型 CM50 发送格式 audio get lobe-activation\r\n 返回格式 audio get lobe-activation {"active_status":[true,true,true,true,true,true,true,true]}\r\n 示例 Send：audio get lobe-activation\r\nReturn: audio get lobe-activation {"active_status":[true,true,true,true,true,true,true,true]}\r\n 22. 获取发言者位置坐标（已弃用，建议用23） 返回参数 名称 类型 取值范围 是否必须 参数说明 doa doa[] 无 是 设备doa数组信息 doa 名称 类型 取值范围 是否必须 参数说明 dev_type string 无 是 设备类型 dev_sn string 无 是 设备SN snd_src_num int 无 是 声源个数 snd_src snd_src[] 无 是 声源数据 snd_src 名称 类型 取值范围 是否必须 参数说明 x int 无 是 x轴数值 y int 无 是 y轴数值 z int 无 是 z轴数值 说明 audio 指令 audio get device-sound-talker-position 支持机型 CM50 发送格式 audio get device-sound-talker-position\r\n 返回格式 audio get device-sound-talker-position{"doa":[{"dev_type":"CM50","dev_sn":"sfsfsfsff","snd_src_num":1,"snd_src":[{"x":0,"y":0,"z":0}]}]}\r\n 示例 Send：audio get device-sound-talker-position\r\nReturn: audio get device-sound-talker-position{"doa":[{"dev_type":"CM50","dev_sn":"sfsfsfsff","snd_src_num":1,"snd_src":[{"x":0,"y":0,"z":0}]}]}\r\n 23. 获取发言者位置坐标 返回参数 名称 类型 取值范围 是否必须 参数说明 doa doa[] 无 是 设备doa数组信息 doa 名称 类型 取值范围 是否必须 参数说明 dev_type string 无 是 设备类型 dev_sn string 无 是 设备SN snd_src_num int 无 是 声源个数 snd_src snd_src[] 无 是 声源数据 snd_src 名称 类型 取值范围 是否必须 参数说明 x int 无 是 x轴数值 y int 无 是 y轴数值 z int 无 是 z轴数值 说明 audio 指令 audio get sound-locate 支持机型 CM50 发送格式 audio get sound-locate\r\n 返回格式 audio get sound-locate {"doa":[{"dev_type":"CM50","dev_sn":"sfsfsfsff","snd_src_num":1,"snd_src":[{"x":0,"y":0,"z":0}]}]}\r\n 示例 Send：audio get sound-locate\r\nReturn: audio get sound-locate {"doa":[{"dev_type":"CM50","dev_sn":"sfsfsfsff","snd_src_num":1,"snd_src":[{"x":0,"y":0,"z":0}]}]}\r\n 24. 获取音频参数预设(已弃用，建议用25) 请求参数 名称 类型 必选 约束 说明 » 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一致 说明 audio 指令 audio get param-preset 支持机型 AP08，CM50，CM20 发送格式 audio get param-preset \r\n 返回格式 audio get param-preset {"preset_info":[{"preset_type":"<value>","preset_name":"<value>","preset_id":"<value>"}]} \r\n 示例 Send：audio set param-preset \r\nReturn: audio set param-preset {"preset_info":[{"preset_type":"custom_preset","preset_name":"自定义1","preset_id":"OFQjdE"},{"preset_type":"official_preset","preset_name":"general_preset","preset_id":"general_preset"}]} \r\n 25. 获取音频参数预设 请求参数 名称 类型 必选 约束 说明 » 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一致 说明 audio 指令 audio get preset 支持机型 AP08，AVBridge，CM50，CM20 发送格式 audio get preset\r\n 返回格式 audio get preset {"preset_info":[{"preset_type":"<value>","preset_name":"<value>","preset_id":"<value>"}]}\r\n 示例 Send：audio set preset\r\nReturn: audio set preset {"preset_info":[{"preset_type":"custom_preset","preset_name":"自定义1","preset_id":"OFQjdE"},{"preset_type":"official_preset","preset_name":"general_preset","preset_id":"general_preset"}]}\r\n 26. 设置音频参数预设(已弃用，建议用27) 请求参数 名称 类型 取值范围 是否必须 参数说明 preset_name string / 是 预设的唯一名字，中文要用utf8 说明 audio 指令 audio set param-preset {"preset_name":"<value>"} 支持机型 AP08，CM50，CM20 发送格式 audio set param-preset {"preset_name":"<value>"}\r\n 返回格式 audio set param-preset {"preset_name":"<value>"}\r\n 示例 Send：audio set param-preset {"preset_name":"自定义1"}\r\nReturn: audio set param-preset {"preset_name":"自定义1"}\r\n 27. 设置音频参数预设 请求参数 名称 类型 取值范围 是否必须 参数说明 preset_name string / 是 预设的唯一名字，中文要用utf8 说明 audio 指令 audio set preset {"preset_name":"<value>"} 支持机型 AP08，AVBridge，CM50，CM20 发送格式 audio set preset {"preset_name":"<value>"} \r\n 返回格式 audio set preset {"preset_name":"<value>"} \r\n 示例 Send：audio set preset {"preset_name":"自定义1"} \r\nReturn: audio set -preset {"preset_name":"自定义1"} \r\n 28. 设置增益(已弃用，建议用29) 请求参数 名称 类型 必选 约束 说明 » arr_gain_info [object] true none none »» name string true none Designer UI 上显示的通道名称 »» value integer true [-60, 20] none 说明 audio 指令 audio set gain {"arr_gain_info":[{"name":"<value>","value":<value>}]} 支持机型 AP08，CM50，CM20 发送格式 audio set gain {"arr_gain_info":[{"name":"<value>","value":<value>}]} \r\n 返回格式 audio set gain {"arr_gain_info":[{"name":"<value>","value":<value>}]} \r\n 示例 Send：audio set gain {"arr_gain_info":[{"name":"USB-Input-1","value":10},{"name":"USB-Input-2","value":10}]} \r\nReturn: audio set gain {"arr_gain_info":[{"name":"USB-Input-1","value":10},{"name":"USB-Input-2","value":10}]} \r\n 29. 设置通道增益 请求参数 名称 类型 必选 约束 说明 » arr_gain_info [object] true none none »» name string true none Designer UI 上显示的通道名称 »» value integer true [-60, 20] none 说明 audio 指令 audio set channel gain {"arr_gain_info":[{"name":"<value>","value":<value>}]} 支持机型 AP08，AVBridge，CM50，CM20 发送格式 audio set channel gain {"arr_gain_info":[{"name":"<value>","value":<value>}]} \r\n 返回格式 audio set channel gain {"arr_gain_info":[{"name":"<value>","value":<value>}]} \r\n 示例 Send：audio set channel gain {"arr_gain_info":[{"name":"USB-Input-1","value":10},{"name":"USB-Input-2","value":10}]} \r\nReturn: audio set channel gain {"arr_gain_info":[{"name":"USB-Input-1","value":10},{"name":"USB-Input-2","value":10}]} \r\n 30. 获取当前增益(已弃用，建议用31) 请求参数： 名称 类型 必选 约束 说明 » arr_gain_info [object] true none none 返回参数： 名称 类型 必选 约束 说明 » arr_gain_info [object] true none none »» name string true none Designer UI 上显示的通道名称 »» value integer true [-60, 20] none 说明 audio 指令 audio get gain {"arr_gain_info":["<value>"]} 支持机型 AP08，CM50，CM20 发送格式 audio get gain {"arr_gain_info":["<value>"]} \r\n 返回格式 audio get gain {"arr_gain_info":[{"name":"<value>","value":<value>}]} \r\n 示例 Send：audio get gain {"arr_gain_info":["USB_IN-1","USB_IN-0"]} \r\nReturn: audio get gain {"arr_gain_info":[{"name":"USB-Input-1","value":10},{"name":"USB-Input-2","value":10}]} \r\n 31. 获取当前增益 请求参数： 名称 类型 必选 约束 说明 arr_gain_info string[] true none none 返回参数： 名称 类型 必选 约束 说明 » arr_gain_info [object] true none none »» name string true none Designer UI 上显示的通道名称 »» value integer true [-60, 20] none 说明 audio 指令 audio get channel gain {"arr_gain_info":["<value>"]} 支持机型 AP08，AVBridge，CM50，CM20 发送格式 audio get channel gain {"arr_gain_info":["<value>"]} \r\n 返回格式 audio get channel gain {"arr_gain_info":[{"name":"<value>","value":<value>}]} \r\n 示例 Send：audio get channel gain {"arr_gain_info":["USB_IN-1","USB_IN-0"]} \r\nReturn: audio get channel gain {"arr_gain_info":[{"name":"USB-Input-1","value":10},{"name":"USB-Input-2","value":10}]} \r\n特殊说明：如果不填参数，返回所有通道的增益值 32. 设置音频外部输入降噪 请求参数 名称 类型 取值范围 是否必须 参数说明 level int [0,1] 是 降噪控制等级1：打开 0：关闭 sn string 无 否 设备唯一标识 说明 audio 指令 audio external-input set noise-reduction {"level":"<value>","sn":"<value>"} 支持机型 Yealink RoomConnect 发送格式 audio external-input set noise-reduction {"level":0,"sn":"506011D110000054"} \r\n 返回格式 audio external-input set noise-reduction {"level":0,"sn":"506011D110000054"} \r\n 示例 Send：audio external-input set noise-reduction {"level":0,"sn":"506011D110000054"} \r\n Return: audio external-input set noise-reduction {"level":0,"sn":"506011D110000054"} \r\n 33. 设置通道mute状态 请求参数 请求参数： Body: 名称 类型 必选 约束 说明 » channel_mute [object] true none none »» name string true none Designer UI 上显示的通道名称 »» status string true [off, on] none 说明 audio 指令 audio set channel mute {"channel_mute":[{"name":"<value>","status":<value>}]} 支持机型 AP08，AVBridge,CM50，CM20 发送格式 audio set channel mute {"channel":[{"name":"<value>","value":<value>}]} \r\n 返回格式 audio set channel mute {} \r\n 示例 Send：audio set channel mute {"channel_mute":[{"name":"Pickup-Area-1","status":"on"},{"name":"Amplifier-Area-1","status":"off"}]} \r\nReturn: audio set channel mute {"channel_mute":[{"name":"Pickup-Area-1","status":"on"},{"name":"Amplifier-Area-1","status":"off"}]} \r\n 34. 获取通道mute状态 请求参数： Body: 名称 类型 必选 约束 说明 » channel_mute [object] true none none 返回参数： Body: 名称 类型 必选 约束 说明 » channel_mute [object] true none none »» name string true none Designer UI 上显示的通道名称 »» status string true [off, on] none 说明 audio 指令 audio get channel mute {"channel_mute":["<value>"]} 支持机型 AP08，AVBridge，CM50，CM20 发送格式 audio get channel mute {"channel_mute":["<value>"]} \r\n 返回格式 audio get channel mute {"channel_mute":[{"name":"<value>","status":<value>}]} \r\n 示例 Send：audio get channel mute {"channel_mute":["Pickup-Area-1","Amplifier-Area-1"]} \r\nReturn: audio get channel mute {"channel_mute":[{"name":"Pickup-Area-1","status":"on"},{"name":"Amplifier-Area-1","status":"off"}]} \r\n 35. 获取通道音量 请求参数 名称 类型 取值范围 是否必须 参数说明 arr_gain_info string[] - 是 通道名字数组，本质和增益是一个物理量。这个接口必须指定通道名字，不指定通道名字返回的是增益值。 返回参数 名称 类型 取值范围 是否必须 参数说明 arr_gain_info arr_gain_info[] - 是 - arr_gain_info: 名称 类型 取值范围 参数说明 name string - 通道名字 value int [0-100] 通道音量，可能会有误差。如设置50，可能get到的是51 说明 audio 指令 audio get channel volume 支持机型 AP08，AVBridge，CM50，CM20 发送格式 audio get channel volume {"arr_gain_info":["Dante-Input-1","Dante-Input-2"]}\r\n 返回格式 audio get channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":51},{"name":"Dante-Input-2","value":60}]}\r\n Send：audio get channel volume\r\nReturn:audio get channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":51},{"name":"Dante-Input-2","value":60}]}\r\n 36. 设置通道音量 请求参数 名称 类型 取值范围 是否必须 参数说明 arr_gain_info arr_gain_info[] - 是 - arr_gain_info: 名称 类型 取值范围 参数说明 name string - 通道名字 value int [0-100] 通道音量，可能会有误差。如设置50，可能get到的是51 说明 audio 指令 audio set channel volume 支持机型 AP08，AVBridge，CM50，CM20 发送格式 audio set channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":50},{"name":"Dante-Input-2","value":60}]}\r\n 返回格式 audio set channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":50},{"name":"Dante-Input-2","value":60}]}\r\n Send：audio set channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":50},{"name":"Dante-Input-2","value":60}]}\r\nReturn:audio set channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":50},{"name":"Dante-Input-2","value":60}]}\r\n meeting-platform 语法 1. 获取会议平台列表 返回参数 名称 类型 取值范围 参数说明 mode-list string 参考范围：[ume,yms,zoom,general,tencent,feishu,byod] 设备的会议平台列表ume：ume会议yms：yms会议zoom：zoom会议general：Yealink会议tencent：腾讯会议feishu：飞书byod：外设模式 说明 meeting-platform 指令 meeting-platform get mode-list 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50注意：1、返回的会议平台以设备当中安装/存在的会议平台为准 发送格式 meeting-platform get mode-list\r\n 返回格式 meeting-platform get mode-list {"mode-list":["ume","yms","zoom"]} \r\n 示例 Send：meeting-platform get mode-list \r\n Return: meeting-platform get mode-list {"mode-list":["ume","yms","zoom"]}\r\n 2. 设置当前会议平台 请求参数 名称 类型 取值范围 是否必须 参数说明 type string 参考范围：[ume,yms,zoom,general,tencent,feishu,byod] 是 设备安装的会议平台ume：ume会议yms：yms会议zoom：zoom会议general：Yealink会议tencent：腾讯会议feishu：飞书byod：外设模式 说明 meeting-platform 指令 meeting-platform set {"type":"<value>"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50注意：1、设置的会议平台以get接口获取到当前存在的平台为准 发送格式 meeting-platform set {"type":"ume"}\r\n 返回格式 meeting-platform set {"type":"ume"}\r\n 示例 Send：meeting-platform set {"type":"ume"} \r\n Return: meeting-platform set {"type":"ume"} \r\n 3. 获取当前会议平台 返回参数 名称 类型 取值范围 参数说明 name string 无 当前平台名称 说明 meeting-platform 指令 meeting-platform get current-mode 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 meeting-platform get current-mode \r\n 返回格式 meeting-platform get current-mode {"name":"ume"} \r\n 示例 Send：meeting-platform get current-mode \r\n Return: meeting-platform get current-mode {"name":"ume"} \r\n bluetooth语法 1. 设置蓝牙开关状态 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 蓝牙状态off：关闭on：开启 说明 bluetooth 指令 bluetooth set {"status":"<value>"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect 发送格式 bluetooth set {"status":"on"}\r\n 返回格式 bluetooth set {"status":"on"}\r\n 示例 Send：bluetooth set {"status":"on"} \r\nReturn: bluetooth set {"status":"on"} \r\n network语法 1. 获取网络信息 返回参数 名称 类型 取值范围 备注 network-list network_info [] 无 网络信息列表 network_info 名称 类型 取值范围 备注 type int [0,1] 获取网络方式0：动态获取1：静态设置 port-type int [0,1,2] 网口类型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服务器名 说明 network 指令 network get info 支持机型 UVC40，MeetingBoard 65/86，MeetingEye 500/900，MeetingBar A10/A40，Yealink RoomConnect注意：1. UVC40只有无线网口信息2. MeetingBoard 65/86支持有线网口1与无线网口3. SmartVision 40只支持有线网口 发送格式 network get info\r\n 返回格式 network get info {"network-list":[{"type":0,"port-type":2,"mode":0,"ip":"","mask":"","gateway":"","primary-dns":"","second-dns":""},{"type":0,"port-type":0,"mode":0,"ip":"10.50.67.59","mask":"255.255.255.0","gateway":"10.50.67.254","primary-dns":"10.100.1.10","second-dns":"192.168.1.22"}]}\r\n 示例 Send：network get info \r\n Return: network get info {"network-list":[{"type":0,"port-type":2,"mode":0,"ip":"","mask":"","gateway":"","primary-dns":"","second-dns":""},{"type":0,"port-type":0,"mode":0,"ip":"10.50.67.59","mask":"255.255.255.0","gateway":"10.50.67.254","primary-dns":"10.100.1.10","second-dns":"192.168.1.22"}]} \r\n camera-layout语法 1. 设置摄像机布局状态 请求参数 名称 类型 取值范围 是否必须 参数说明 status string [on,off] 是 摄像机布局状态on：启用off：禁用 说明 camera-layout 指令 camera-layout set switch {"status":"<value>"} 支持机型 Yealink RoomConnect 发送格式 camera-layout set switch {"status":"on"}\r\n 返回格式 camera-layout set switch {"status":"on"}\r\n 示例 Send：camera-layout set switch {"status":"on"} \r\nReturn: camera-layout set switch {"status":"on"} \r\n 2. 设置摄像机布局类型 请求参数 名称 类型 取值范围 是否必须 参数说明 type string [fullscreen,div2~div9,1x1~1x8,1xN,divide] 是 布局类型fullscreen：单方全屏布局div2~div9：二分屏~九分屏布局divide：等分布局1xN：1+N布局1x1~1x8：1+1~1+8布局 focus-camera string 无 否 布局中大图画面摄像机sn唯一标识 说明 camera-layout 指令 camera-layout set type {"type":"<value>",["focus-camera":"<value>"]} 支持机型 Yealink RoomConnect，MeetingEye 500注意：1、MeetingEye 500机型的type参数取值范围为fullscreen，divide，1xN2、Yealink RoomConnect仅支持type参数，且取值范围为fullscreen，div2~div9，1x1~1x8；设置fullscreen模式时，需要配合 设置摄像机布局摄像机位置功能 指定位置为0的摄像机来应用fullscreen模式3、仅Yealink RoomConnect传入small-screen-position，small-screen-size，main-screen-type,second-screen-type参数，且此四个参数均针对画中画布局生效4、仅Yealink RoomConnect支持sn参数5、仅MeetingEye 500机型支持focus-camera参数 发送格式 Yealink RoomConnect：camera-layout set 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"}}\r\nM500:camera-layout set type {"type":"fullscreen","focus-camera": "8703018090000132"}\r\n 返回格式 Yealink RoomConnect：camera-layout set 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"}}\r\nM500:camera-layout set type {"type":"fullscreen","focus-camera": "8703018090000132"}\r\n 示例 Yealink RoomConnect：Send：camera-layout set 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"}}\r\nReturn: camera-layout set 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"}}\r\nM500:Send：camera-layout set type {"type":"fullscreen","focus-camera": "8703018090000132"} \r\nReturn:camera-layout set type {"type":"fullscreen","focus-camera": "8703018090000132"} \r\n 3. 设置摄像机布局摄像机位置(MVC设备) 请求参数 名称 类型 取值范围 是否必须 参数说明 position-list object 无 是（AVhub） 摄像机列表参数 >> sn 是（AVhub） 摄像头唯一标识 >> left [0~1920] 是（AVhub） 摄像头布局画面显示位置左坐标 >> top [0~1080] 是（AVhub） 摄像头布局画面显示位置顶部坐标 >> width [0~1920] 是（AVhub） 摄像头布局画面显示的宽度 >> height [0~1080] 是（AVhub） 摄像头布局画面显示的高度 说明 camera-layout 指令 camera-layout set position {"position-list":[{"sn":"<value>","left":<value>,"top":<value>,"width":<value>,"height":<value>},{"sn":"<value>","left":<value>,"top":<value>,"width":<value>,"height":<value>}]} 支持机型 AVHub注意：position-list内的摄像机位置参数个数可以根据实际摄像机个数可选设置。 发送格式 camera-layout set position {"position-list":[{"sn":"806009E070000512","left":0,"top":134,"width":1440,"height":810},{"sn":"806007D120000442","left":1440,"top":134,"width":480,"height":270}]}\r\n 返回格式 camera-layout set position {"position-list":[{"sn":"806009E070000512","left":0,"top":134,"width":1440,"height":810},{"sn":"806007D120000442","left":1440,"top":134,"width":480,"height":270}]}\r\n 示例 Send：camera-layout set position {"position-list":[{"sn":"806009E070000512","left":0,"top":134,"width":1440,"height":810},{"sn":"806007D120000442","left":1440,"top":134,"width":480,"height":270}]}\r\nReturn:camera-layout set position {"position-list":[{"sn":"806009E070000512","left":0,"top":134,"width":1440,"height":810},{"sn":"806007D120000442","left":1440,"top":134,"width":480,"height":270}]}\r\n 4. 设置摄像机布局摄像机位置（YRC） 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 是 摄像头唯一标识 position int [0~8] 是 位置标识 说明 camera-layout 指令 camera-layout set position {"sn":"<value>","position":<value>} 支持机型 Yealink RoomConnect注意：设置fullscreen模式时，需要配合 设置摄像机布局摄像机位置功能 指定位置为0的摄像机来应用fullscreen模式 发送格式 camera-layout set position {"sn":"8703018090000132","position":2}\r\n 返回格式 camera-layout set position {"sn":"8703018090000132","position":2}\r\n 示例 Send：camera-layout set position {"sn":"8703018090000132","position":2} \r\nReturn: camera-layout set position {"sn":"8703018090000132","position":2} \r\n 布局位置遵循从左到右顺序，以等分与1+N的最大数量为参考： 等分： 1+N： 5. 获取摄像机布局类型 返回参数 名称 类型 取值范围 参数说明 type string [fullscreen,1xN,divide] 布局类型fullscreen：单方全屏布局divide：等分布局 1xN：1+N布局 focus-camera string 无 布局中大图画面摄像机sn唯一标识 说明 camera-layout 指令 camera-layout get type 支持机型 MeetingEye 500注意：1、MeetingEye 500机型和AVHub的type参数取值范围为fullscreen，divide，1xN 发送格式 camera-layout get type \r\n 返回格式 camera-layout get type {"type":"fullscreen","focus-camera":"8703018090000132"} \r\n 示例 Send：camera-layout get type \r\nReturn:  camera-layout get type {"type":"fullscreen","focus-camera":"8703018090000132"} \r\n upgrade语法 1. 设备升级 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 否 升级的设备sn device string 无 否 升级的设备类型 url string 无 是 升级的固件地址(url地址或本地路径) time int -1~23 否 升级时间 -1：立即升级  0~23：升级时间 说明 upgrade 指令 upgrade firmware start {["sn":"<value>",],["device":"<value>"],path:"<value>",time:<value>} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50，Yealink RoomConnect注意：1、仅Yealink RoomConnect支持传sn和device参数， 至少填写sn和device其中一个参数 2、sn与device理论上只填一种，同时填写，只生效sn参数 发送格式 upgrade firmware start {"sn":"801203F04C600791","url":"https://packet-nexus.yealink.com/repository/repo-packet-develop/AllRom/MeetingBarA40-rom/289.320.254.315/MeetingBarA40-289.320.254.315-mix.rom","time":-1} \r\n`` 返回格式 upgrade firmware start {"sn":"801203F04C600791","url":"https://packet-nexus.yealink.com/repository/repo-packet-develop/AllRom/MeetingBarA40-rom/289.320.254.315/MeetingBarA40-289.320.254.315-mix.rom","time":-1} \r\n`` 示例 携带sn参数情况：Send：upgrade firmware start {"sn":"803032E070000031","url":"https://packet-nexus.yealink.com/service/rest/repository/browse/repo-packet-release/AllRom/UVC86-rom/151.0.249.13/UVC86-151.0.249.13.rom","time":\-1} \r\n Return: upgrade firmware start {"sn":"803032E070000031","url":"https://packet-nexus.yealink.com/service/rest/repository/browse/repo-packet-release/AllRom/UVC86-rom/151.0.249.13/UVC86-151.0.249.13.rom","time":\-1} \r\n携带device参数情况：Send： upgrade firmware start {"device":"uvc86","url":"https://packet-nexus.yealink.com/service/rest/repository/browse/repo-packet-release/AllRom/UVC86-rom/151.0.249.13/UVC86-151.0.249.13.rom","time":\-1} \r\n Return: upgrade firmware start {"device":"uvc86","url":"https://packet-nexus.yealink.com/service/rest/repository/browse/repo-packet-release/AllRom/UVC86-rom/151.0.249.13/UVC86-151.0.249.13.rom","time":\-1} \r\n 2. 设备取消升级 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 否 停止升级的设备sn device string 无 否 升级的设备类型 说明 upgrade 指令 upgrade firmware cancel {["sn":"<value>"],["device":"<value>"]} 支持机型 Yealink RoomConnect注意：1、sn与device理论上只填一种，同时填写，只生效sn参数2、sn与device都不填时，取消全部升级 发送格式 upgrade firmware cancel {"sn":"803032E070000031","device":"uvc86"} \r\n 返回格式 upgrade firmware cancel {"sn":"803032E070000031","device":"uvc86"} \r\n 示例 携带sn参数情况：Send：upgrade firmware cancel {"sn":"803032E070000031"} \r\n Return: upgrade firmware cancel{"sn":"803032E070000031"}\r\n携带device参数情况：Send：upgrade firmware cancel {"device":"uvc86"} \r\n Return: upgrade firmware cancel{"device":"uvc86"} \r\n 3.获取升级状态 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 是 获取升级状态的设备sn 返回参数 名称 类型 取值范围 参数说明 status string [downloading,upgrading,success,fail] 下载状态：downloading：下载中upgrading：升级中 success：成功fail：失败 progress int 0~100 升级进度，仅升级中返回正常值，否则为-1 说明 upgrade 指令 upgrade firmware get status {"sn":"<value>"} 支持机型 Yealink RoomConnect 发送格式 upgrade firmware get status {"sn":"803032E070000031"}\r\n 返回格式 upgrade firmware get status {"status":"upgrading", "progress": 48} \r\n 示例 Send: upgrade firmware get status {"sn":"803032E070000031"}\r\nReturn: upgrade firmware get status {"status":"upgrading", "progress": 48} \r\n diagnostics语法 1. 获取日志 返回参数 名称 类型 取值范围 参数说明 文件路径 string 无 文件路径（需主动去下载才可获取到日志文件） 说明 diagnostics 指令 diagnostics get log 支持机型 Yealink RoomConnect，MeetingDisplay，MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 diagnostics get log \r\n 返回格式 diagnostics get log {file} \r\n 示例 Send: diagnostics get log \r\nReturn: diagnostics get log {file}\r\n 2. 网络诊断 请求参数 名称 类型 取值范围 是否必须 参数说明 action string pingtraceroute 是 ping执行语句：ping -c num iptraceroute执行语句：traceroute -m num -I ip num int 1~30 是 ping次数；或traceroute跟踪的最大跳数 ip string 无 是 目标ip/域名 返回参数 名称 类型 取值范围 参数说明 result string 无 执行语句返回内容 说明 diagnostics 指令 diagnostics network{"action":"<value>","num":"<value>","ip":"<value>"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 diagnostics network {"action": "ping","num": 5,"ip": "10.50.150.1"} \r\n 返回格式 diagnostics network "PING 10.56.23.9 (10.56.23.9) 56(84) bytes of data.64 bytes from 10.56.23.9: icmp_seq=1 ttl=64 time=0.111 ms64 bytes from 10.56.23.9: icmp_seq=2 ttl=64 time=0.049 ms64 bytes from 10.56.23.9: icmp_seq=3 ttl=64 time=0.050 ms64 bytes from 10.56.23.9: icmp_seq=4 ttl=64 time=0.047 ms64 bytes from 10.56.23.9: icmp_seq=5 ttl=64 time=0.072 ms -- 10.56.23.9 ping statistics ---5 packets transmitted, 5 received, 0% packet loss, time 4099msrtt min/avg/max/mdev = 0.047/0.065/0.111/0.026 ms "\r\n 示例 Send:diagnostics network {"action": "ping","num": 5,"ip": "10.50.150.1"} \r\nReturn: diagnostics network "PING 10.56.23.9 (10.56.23.9) 56(84) bytes of data.64 bytes from 10.56.23.9: icmp_seq=1 ttl=64 time=0.111 ms64 bytes from 10.56.23.9: icmp_seq=1 ttl=64 time=0.049 ms64 bytes from 10.56.23.9: icmp_seq=1 ttl=64 time=0.050 ms64 bytes from 10.56.23.9: icmp_seq=1 ttl=64 time=0.047 ms64 bytes from 10.56.23.9: icmp_seq=1 ttl=64 time=0.072 ms -- 10.56.23.9 ping statistics ---5 packets transmitted, 5 received, 0% packet loss, time 4099msrtt min/avg/max/mdev = 0.047/0.065/0.111/0.026 ms "\r\n 3. 开启或停止抓包文件 请求参数 名称 类型 取值范围 是否必须 参数说明 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时设备端响应最近未上传文件 返回参数 名称 类型 取值范围 参数说明 抓包文件名 string 无 响应get/stop操作；上传抓包文件本身，无文件类型后缀 名称 类型 取值范围 参数说明 文件流 file 无 文件流数据（需主动触发下载才可获取到文件） 说明 diagnostics 指令 diagnostics packetcapture {"operation":"<value>", "interface":"<value>","filter":"<value>","filter-type": "<value>"} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50注意：1、如果抓包数据缓存数据达到5M，才能使用get数据获取到抓包数据，get后数据会清除，直到达到5M，再去取才有数据。2、如果不需要实时get数据，建议直接stop获取当前搜集的抓包数据。3、抓包缓存5M是由于如果缓存太小，异步抓包可能导致抓包数据不全。 发送格式 抓包开始：diagnostics packetcapture {"operation":"start","interface":"wan","filter":"tcp","filter-type":"0"} \r\n获取抓包：diagnostics packetcapture {"operation":"get"}停止抓包：diagnostics packetcapture {"operation":"stop"} 返回格式 抓包开始：diagnostics packetcapture {"operation":"start","interface":"wan","filter":"tcp","filter-type":"0"} \r\n获取抓包：diagnostics packetcapture /tmp/cc_pcap/cc_merge.pcap停止抓包：diagnostics packetcapture /tmp/cc_pcap/cc_merge.pcap 示例 抓包开始：Send: diagnostics packetcapture {"operation":"start","interface":"wan","filter":"tcp","filter-type":"0"} \r\nReturn: diagnostics packetcapture {"operation":"start","interface":"wan","filter":"tcp","filter-type":"0"} \r\n获取抓包：Send: diagnostics packetcapture {"operation":"get"} \r\nReturn: diagnostics packetcapture /tmp/cc_pcap/cc_merge.pcap停止抓包：Send: diagnostics packetcapture {"operation":"stop"}Return: diagnostics packetcapture /tmp/cc_pcap/cc_merge.pcap 4. 告警 请求参数 名称 类型 取值范围 是否必须 参数说明 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地址 说明 diagnostics 指令 diagnostics get alert{["severity":"<value>"],["from-time":"<value>"]} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 diagnostics get alert {"severity": "all", "from-time": 1720430000}\r\n 返回格式 diagnostics get alert {"alert-list":[{"action-time":1720431643,"ip":"10.56.23.9","mac":"24:9A:D8:5A:4C:95","name":"Dsk slave disconnect","severity":"Minor"},{"action-time":1720431749,"ip":"10.56.23.9","mac":"24:9A:D8:5A:4C:95","name":"Dsk slave disconnect","severity":"Minor"},{"action-time":1720508139,"ip":"","mac":"24:9A:D8:5A:4C:95","name":"Dsk slave disconnect","severity":"Minor"}]} \r\n 示例 Send:diagnostics get alert {"severity": "all", "from-time": 1720430000}\r\nReturn: diagnostics get alert {"alert-list":[{"action-time":1720431643,"ip":"10.56.23.9","mac":"24:9A:D8:5A:4C:95","name":"Dsk slave disconnect","severity":"Minor"},{"action-time":1720431749,"ip":"10.56.23.9","mac":"24:9A:D8:5A:4C:95","name":"Dsk slave disconnect","severity":"Minor"},{"action-time":1720508139,"ip":"","mac":"24:9A:D8:5A:4C:95","name":"Dsk slave disconnect","severity":"Minor"}]} \r\n call语法 1. 获取通话状态 返回参数 名称 类型 取值范围 参数说明 call-state string [incoming, incall, idle] incoming：来电中incall：正在通话idle：空闲incoming、incall两种状态可视为通话中 app-info app_info 无 正在通话中的app信息，若非通话中，则对应信息都为 "" app_info 名称 类型 备注 id string app包名 name string app名称 version string app版本号 说明 diagnostics 指令 call get state 支持机型 Yealink RoomConnect ,MeetingBoard 65/86/65 Pro/75 Pro/86 Pro，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50，SmartVision 40 说明：SmartVision 40支持incall和idle两种状态 发送格式 call get state \r\n 返回格式 call get state {"call-status":"idle","app-info":{"id":"","name":"","version":""}}\r\n 示例 Send:call get state\r\nReturn: call get state {"call-status":"idle","app-info":{"id":"","name":"","version":""}}\r\n splitroom语法 1. 设置可分割会议室状态 请求参数 名称 类型 取值范围 是否必须 参数说明 sn string 无 是 请求方身份标识 value int [0~3] 是 可分割会议室状态0：关闭可分割会议室功能1：可分割会议室下独立模式2：可分割会议室下被合并房间3：可分割会议室下主控房间 说明 upgrade 指令 splitroom set status {"sn":"<value>","value":"<value>"} 支持机型 Yealink RoomConnect 发送格式 splitroom set status {"sn":"506011D110000054","value":"1"} \r\n 返回格式 splitroom set status {"sn":"506011D110000054","value":"1"} \r\n 示例 Send：splitroom set status {"sn":"506011D110000054","value":"1"} \r\nReturn: splitroom set status {"sn":"506011D110000054","value":"1"} \r\n division 语法 1. 设置设备当前分割状态（已弃用，建议用2） 请求参数 名称 类型 取值范围 是否必须 参数说明 value int [0, 1] 是 0：合并状态 1：分割状态 说明 division 指令 division set status {"value":<value>} 支持机型 AP08 发送格式 division set status {"value":1} \r\n 返回格式 division set status {"value":1} \r\n 示例 Send：division set status {"value":1} \r\nReturn: division set status {"value":1} \r\n 2. 设置设备当前分割状态 请求参数 名称 类型 取值范围 是否必须 参数说明 room_info room_info[] - 是 房间信息 room_info: 名称 类型 取值范围 是否必须 参数说明 room_id int[] [1,3] 是 分割后每个房间包含的最小可分割的房间的id 说明 division-room指令 division-room set config 支持机型 AP08 发送格式 division set config {"room_info":[{"room_id":[1,2]},{"room_id":[3]}]}\r\n 返回格式 division set config {"room_info":[{"room_id":[1,2]},{"room_id":[3]}]}\r\n 示例 Send:division set config {"room_info":[{"room_id":[1,2]},{"room_id":[3]}]}\r\nReturn:division set config {"room_info":[{"room_id":[1,2]},{"room_id":[3]}]}\r\n 3. 获取设备当前分割状态(已弃用，建议用4) 返回参数 名称 类型 取值范围 是否必须 参数说明 value int [0, 1] 是 0：合并状态 1：分割状态 说明 division 指令 division get status {"value":<value>} 支持机型 AP08 发送格式 division get status {} \r\n 返回格式 division get status {"value":1} \r\n 示例 Send：division get status {} \r\nReturn: division get status {"value":1} \r\n 4. 获取设备当前分割状态 返回参数 名称 类型 取值范围 是否必须 参数说明 room_info room_info[] - 是 房间信息 room_info: 名称 类型 取值范围 是否必须 参数说明 room_id int[] [1,3] 是 分割后每个房间包含的最小可分割的房间的id 说明 division-room division-room get config 支持机型 AP08 发送格式 division-room get config\r\n 返回格式 division-room get config {"room_info":[{"room_id":[1]},{"room_id":[2]},{"room_id":[3]}]}\r\n 示例 Send:division-room get config\r\nReturn:division-room get config {"room_info":[{"room_id":[1]},{"room_id":[2]},{"room_id":[3]}]}\r\n physical-interface语法 1. 获取物理接口列表 请求参数 名称 类型 取值范围 是否必须 参数说明 type string 无 是 接口类别ALL：全部类别AUDIO：音频接口VIDEO：适配接口OTHRES：其他接口 说明 division 指令 phiysical-interface get list {"type":<value>} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 phiysical-interface get list {"type":"ALL"} \r\n 返回格式 phiysical-interface get list {"interface-list":[{"id":0,"name":"HDMI_IN","type":"VIDEO","connected":false,"status":"on"},{"id":1,"name":"HDMI_IN","type":"VIDEO","connected":false,"status":"on"}]} \r\n 示例 Send：phiysical-interface get list {"type":"ALL"} \r\nReturn: phiysical-interface get list {"interface-list":[{"id":0,"name":"HDMI_IN","type":"VIDEO","connected":false,"status":"on"},{"id":1,"name":"HDMI_IN","type":"VIDEO","connected":false,"status":"on"}]} \r\n 2. 设置物理接口开关 请求参数 名称 类型 取值范围 是否必须 参数说明 name string 无 是 接口名称 id int 无 是 实际获取接口id status string [on,off] 是 接口状态on：打开off：关闭 说明 division 指令 phiysical-interface set enable {"name":<value>, "id":<value>, "status":<value>} 支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 发送格式 phiysical-interface set enable {"name": "HDMI_IN","id":2, "status": "off"} \r\n 返回格式 phiysical-interface set enable {"name": "HDMI_IN","id":2, "status": "off"} \r\n 示例 Send：phiysical-interface set enable {"name": "HDMI_IN","id":2, "status": "off"} \r\nReturn: phiysical-interface set enable {"name": "HDMI_IN","id":2, "status": "off"} \r\n