目的
本文档详细说明了中央控制模块控制 API 命令的功能与语法。使读者能够快速了解中央控制模块的相关特性,同时为开发者后续的编码工作提供指导。本指南有助于完成 Yealink VCS 和 MVC 产品在网络模式和串行模式下控制主机的开发工作。
功能简介
网络模式配置说明
设备支持通过网络模式控制主机设备,使用 TCP 协议建立连接。客户端需要知晓主机的 IP 地址和端口号,才能连接到主机。
网络模式需配置以下参数:
a. 中央控制的网络模式控制端口配置为:6024
b. IP 地址可根据实际情况查看
c. 若中央控制系统网络模式启用了密码认证,则在使用 TCP 协议建立连接时,需输入密码并成功通过认证后,方可正常执行中央控制命令。输入的密码格式为“XXXX\r\n”,其中 XXXX 代表正确的密码。
例如,在建立 TCP 连接后,如果收到消息“password:\r\n”,表示需要输入认证密码。
如果输入了错误的密码,连接将返回“Invalid Password!\r\nPassword:\r\n”,提示重新输入密码进行认证。
输入正确密码后,连接将返回“welcome yealink central control”。这表明认证成功,你可以继续对中央系统进行控制。
串口模式配置说明
部分设备支持通过串口模式控制主机设备,例如 M500 和 M900。客户端需使用串口线连接主机设备,主机设备将识别串口连接,并通过串行协议建立通信。
串口的波特率、数据位、校验位和停止位可通过设备的 web 用户界面进行配置。
API 指令
API 基本语法说明
本章介绍中心控制 API 命令描述文件。为便于描述 API 命令语法,对 API 编写格式作出如下声明与约定:
指令词均为小写
命令基本结构:命令 + 参数
参数组成:参数名 + 参数值 ------ 以冒号分隔,命令参数格式与 httpapi 一致,以 JSON 字符串形式传输
'app' 参数具有唯一性,与其他参数独立。在传输过程中,该参数独立于 JSON 格式之外。该参数表示所调用的指令属于特定应用。若未包含此参数,默认行为为在系统级别执行指令。
基本数据包格式说明
发送格式说明:使用 \r\n 作为结束标识符。所有 API 命令必须以 \r\n 作为终止符。
返回格式说明:使用 \r\n 作为结束标识符。所有返回包均以 \r\n 作为结束标识符。
命令基本格式:
命令 + \r\n(无参数类型)
命令 + 空格 + json 字符串 + \r\n(有参数类型)
命令 + 空格 + app:值 + 空格 + json 字符串 + \r\n(含参数及 app 参数类型)
API 命令详细说明
有关当前支持的 API 命令的详细说明,请参阅 Socket API 和 HTTPS API。
调试时,可使用 TCP 调试工具,根据上述环境支持说明进行配置,并测试 API 命令。支持的命令和参数可能因不同版本和型号而异。用“ []”括起的参数为可选参数。