API 概述

Lifesize API 提供了一个基于命令行的进入点,以对 Icon 视频系统的访问和控制进行自动化管理。API 支持用 REST 访问通过一组固定的操作来访问资源集或对象集。API 调用方法是向 API 资源发送一个请求并指定方法和参数。得到的格式化响应详细描述了操作的输出。

本节对 Lifesize API 作了介绍。更详细的文档请访问:

https://<videoSystemIPAddress>/docs/clish  (传统命令行界面)

https://<videoSystemIPAddress>/docs/json   (REST API)

验证

浏览器执行的验证策略也同样适用于 API 调用。通过网络利用 SSH 或 HTTP 连接以如下方式登录 Lifesize 视频系统:

  1. 打开一个客户端,比如 Cygwin 或 Putty,并输入 Lifesize 视频系统的 IP 地址。
  2. 用管理员凭据登录系统。默认用户名和密码均为 admin

命令语法

命令采用如下格式:

<actor> <command> <parameters>

 

用逗号分隔多个参数。按照下列方法从命令提示符处显示帮助:

help显示使用 API 的简短介绍。
按键盘上的 Tab 键显示元素列表。
<actor> ? 显示针对某个元素的命令。例如:

audio ?

<actor> <command> ? 显示命令的帮助。例如:

sysadmin gettimezone ?