中控 HttpApi 鉴权说明 由于添加了鉴权机制，需要先执行鉴权流程，成功后拿到 token，后续接口调用附上该 token 校验。 token 有效期为 2 小时。 以 POST 形式请求鉴权，附带 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" } } 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 名称参数。 业务鉴权失败 支持机型 MeetingBoard, MeetingBoard Pro，MeetingBoard C，MeetingEye 500/900，MeetingBar A10/A40 当业务请求时，若出现鉴权失败，将会回复以下响应实例： 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":500 } 此时，客户端可重新进行鉴权请求。 处理超过限制 支持机型 MeetingBoard, MeetingBoard Pro，MeetingBoard C，MeetingEye 500/900，MeetingBar A10/A40 如果业务请求并发量超过十个，就会触发服务器并发量限制机制，将会回复以下响应实例 响应实例 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 支持机型 MeetingBoard, MeetingBoard Pro，MeetingBoard C，MeetingEye 500/900，MeetingBar A10/A40 请求参数： 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" } } 基础信息 基础信息查询/获取（本文档包含系统信息、网络信息、设备列表，其余系统状态、静音状态、音量大小、摄像头信息、屏幕亮度、会议平台列表可查阅 控制服务 文档） 获取系统信息 基本信息 Method： GET Path： /centralcontrol/system/version 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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" } } 获取网络信息 基本信息 Method： GET Path： /centralcontrol/network/info 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： Body: 无 返回值： 名称 类型 取值范围 备注 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服务器名 备注 请求示例 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": "" }, { "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" } ] } } 获取设备列表 基本信息 Method： GET Path： /centralcontrol/system/devices 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 } ] } } 获取 app 信息列表 基本信息 Method： GET Path： /centralcontrol/app/info 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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" } ] } } 获取通话状态 基本信息 Method： GET Path： /centralcontrol/system/call-state 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 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版本号 备注 请求示例 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":"com.yealink.projection", "name":"投屏", "version":"21.1.2-TS.2" } } } 读取内存使用情况 基本信息 Method： GET Path: /centralcontrol/system/memory-info 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingEye 500/900，MeetingBar A10/A40 请求参数 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 } } 控制服务 对设备的音视频设备，显示以及整机进行远程控制，包括控制时需要的状态获取。 系统状态控制 1) 获取系统状态 基本信息 Method： GET Path： /centralcontrol/system/status 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 } } 音频控制 1）获取静音状态 基本信息 Method： GET Path： /centralcontrol/audio/mute 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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）设置静音状态 基本信息 Method： POST Path： /centralcontrol/button 支持机型 MeetingBoard， MeetingBoard Pro， MeetingBoard C，MeetingDisplay， MeetingEye 500/900， MeetingBar A10/A40/A50 该接口操作和实际麦克风状态取反：当前 unmute 状态，post 后即是 mute 状态；当前 mute 状态，post 后即是 unmute 状态 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 key string [mute] 是 按键名 **返回值： 无 备注 请求示例 POST /centralcontrol/button { "key": "mute" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 3）获取音量（mic） 基本信息 Method： GET Path： /centralcontrol/audio/volume 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 可选填音量类型参数，默认为 idle。 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 type string [idle,talk] 否 音量类型idle：铃声音量talk：通话音量 返回值： 名称 类型 取值范围 参数说明 value int [0~15] 音量值 备注 请求示例 GET /centralcontrol/audio/volume { "type": "talk" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200, "data": { "value":5 } } 4）设置音量 基本信息 Method: POST Path: /centralcontrol/audio/volume 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 可选填音量类型参数，默认为idle（单音量模式idle与talk音量会被同步） 请求参数： 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, } 5）获取音频源列表 基本信息 Method： GET Path： /centralcontrol/audio/source-info 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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" ] } } 6）设置音频输入源 基本信息 Method： POST Path： /centralcontrol/audio/input-source 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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, } 7）设置音频输出源 基本信息 Method： POST Path： /centralcontrol/audio/output-source 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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, } 8）获取mic静音状态 基本信息 Method： GET Path： /centralcontrol/audio/mic-mute 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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" } } 摄像头控制 1）摄像头移动 基本信息 Method: POST Path: /centralcontrol/camera/move 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBar A10/A40/A50可选填sn参数 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBar A10/A40/A50可选填sn参数 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBar A10/A40/A50可选填sn参数 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBar A10/A40/A50可选填sn参数 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBar A10/A40/A50可选填sn参数，A10仅支持"ptz, auto-frame, speaker-tracking, view-cropping, multi-screen, pip"模式 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数；如果存在多个摄像头时，需要使用sn指定对应摄像头进行正确操作 MeetingEye 500接入UVC86设备后支持的模式为"ptz，auto-frame，speaker-tracking，smart-gallery，presenter-tracking"、接入UVC84设备支持"ptz，auto-frame"模式 MeetingBoard 65/86支持"ptz，auto-frame，speaker-tracking，multi-screen，pip，smart-gallery，presenter-tracking"模式 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBar A10/A40/A50可选填sn参数 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 MeetingBar A10/A40/A50可选填sn参数 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900仅有一个摄像机时，可以选填sn参数，如果存在多个摄像头时，需要使用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/active 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingEye 500/900 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 sn string 无 否 摄像头唯一标识 返回值： 无 备注 请求示例 POST /centralcontrol/camera/active { "sn": "506607D117000009" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 显示控制 1）获取屏幕亮度 基本信息 Method： GET Path： /centralcontrol/screen/brightness 支持机型 MeetingBoard，MeetingBoard Pro, MeetingBoard C，MeetingDisplay 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro, MeetingBoard C, MeetingDisplay 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 id int 无 否 屏幕id(取值于获取设备列表信息的设备标识) 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 支持机型 MeetingBoard，MeetingBoard Pro, MeetingBoard C, MeetingDisplay 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro, MeetingBoard C, MeetingDisplay 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro, MeetingBoard C, MeetingDisplay 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro, MeetingBoard C, MeetingDisplay 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro, MeetingBoard C, MeetingDisplay 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay 请求参数： 名称 类型 取值范围 是否必须 参数说明 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay 请求参数： 名称 类型 取值范围 是否必须 参数说明 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay注意：只有色温模式为3（custom）时，设置的色温参数才生效 请求参数： 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 } 多模控制 1）获取会议平台列表 基本信息 Method： GET Path： /centralcontrol/meeting-platform/mode-list 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 返回的会议平台以设备当中安装/存在的会议平台为准。 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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" } } 无线控制 1）设置蓝牙开关 基本信息 Method： POST Path： /centralcontrol/bluetooth 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 } 摄像机布局控制 1）设置摄像机布局类型 基本信息 Method： POST Path： /centralcontrol/camera-layout/type 支持机型 MeetingEye 500 MeetingEye 500 机型的type参数取值范围为fullscreen，divide，1xN。 设置fullscreen模式时，需要配合 设置摄像机布局摄像机位置功能 指定位置为0的摄像机来应用fullscreen模式。 仅MeetingEye 500机型支持focus-camera参数。 请求参数： 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：自动框人像 说明 仅画中画布局设置有效。 返回值： 无 备注 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 } 2）获取摄像机布局类型 基本信息 Method： GET Path： /centralcontrol/camera-layout/type 支持机型 MeetingEye 500 MeetingEye 500机型的type参数取值范围为fullscreen，divide，1xN。 请求参数： 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" } } app控制 1）打开app到前台 基本信息 Method： POST Path： /centralcontrol/app/start 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： Body: 名称 类型 取值范围 是否必须 参数说明 id string 参考基础信息文档接口获取app信息列表中的 id 值 是 app包名 返回值： 无 备注 请求示例 POST /centralcontrol/app/start { "id": "com.yealink.byod" } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status":200 } 参数错误： { "status":400 } 2）获取前台app 基本信息 Method： GET Path： /centralcontrol/app/foreground 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： Body: 无 返回值： 名称 类型 备注 id string app包名 name string app名称 version string app版本号 请求示例 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" } } 接口权限 1）获取物理接口列表 基本信息 Method： GET Path： /centralcontrol/phiysical-interface/list 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 } 其他 1）遥控器按键操作 基本信息 Method： POST Path： /centralcontrol/button 支持机型 MeetingEye 500 请求参数： 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 } 健康服务 监控设备健康状态，能提供告警机制 设置日志服务器地址 基本信息 Method： POST Path： /centralcontrol/system/log-server 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 当关闭日志服务器时，可以不输入其他参数，否则必须携带参数 建议使用参数：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 } 获取系统日志 基本信息 Method： GET Path： /centralcontrol/diagnostics/log 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： Body: 无 返回值： 名称 类型 取值范围 参数说明 文件流 file 无 （需主动触发下载才可获取到文件） 备注 请求示例 GET /centralcontrol/diagnostics/log { } 响应实例 HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 file 网络诊断 基本信息 Method： POST Path： /centralcontrol/diagnostics/network 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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 } 开启或停止抓包文件上传 基本信息 Method： POST Path： /centralcontrol/diagnostics/packetcapture 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 如果抓包数据缓存数据达到5M，才能使用get数据获取到抓包数据，get后数据会清楚，直到达到5M，再去取才有数据。 如果不需要实时get数据，建议直接stop获取当前搜集的抓包数据。 抓包缓存5M是由于如果缓存太小，异步抓包可能导致抓包数据不全。 请求参数： 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 告警 基本信息 Method： GET Path： /centralcontrol/diagnostics/alert 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 请求参数： 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" } ] } } 更新服务 更新设备本身以及周边配件的固件 设备升级 基本信息 Method： POST Path： /centralcontrol/upgrade/firmware/start 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C，MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50 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 } 配置服务 配置文件更新 本操作可提供 Wi-Fi开关/无线热点开关/蓝牙开关 等一系列开关的配置更新（注意：通话中不能进行配置文件更新操作） 基本信息 Method： POST Path： /centralcontrol/config/update 支持机型 MeetingBoard，MeetingBoard Pro，MeetingBoard C, MeetingDisplay，MeetingEye 500/900，MeetingBar A10/A40/A50/A50 请求参数： 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 }