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>

 

使用逗點隔開多個參數。從命令提示顯示以下説明:

說明顯示有關使用 API 的簡短介紹。
按鍵盤上的 Tab 鍵顯示動作項目的清單。
<actor> ? 顯示針對動作項目的命令。例如:

audio ?

<actor> <command> ? 顯示一條命令的說明 例如:

sysadmin gettimezone ?