Introducción a la API

La API de Lifesize proporciona un punto de acceso mediante línea de comandos para automatizar el acceso y el control de los sistemas de vídeo Icon. Esta API admite un método REST para acceder a una serie de recursos, u objetos, a través de un conjunto fijo de operaciones. Las llamadas a la API se realizan enviando una solicitud a un recurso de API y especificando un método y argumentos. Una respuesta con formato detalla el resultado de la operación.

Operación y configuración de CLI con Lifesize Icons

Los siguientes Lifesize Icons pueden aprovechar el uso de la interfaz de línea de comandos (CLI): Todos los Lifesize Icons (300, 400, 450, 500, 600, 700, 800)

La interfaz de línea de comandos (CLI) de Lifesize Automation proporciona un punto de entrada basado en línea de comandos para automatizar el acceso y el control de los sistemas de comunicaciones por video de Lifesize. La CLI le permite:

  • Recupere la información de configuración de su sistema Lifesize. Por ejemplo, puede obtener el número de versión del sistema o la configuración de brillo de la cámara.
  • Aplicar nuevas preferencias a la configuración del sistema. Por ejemplo, puede configurar el volumen del altavoz o el temporizador de atenuación gradual, cambiar las preferencias de ancho de banda, la respuesta automática, etc.
  • Mostrar el estado de las llamadas en el sistema. Por ejemplo, puede mostrar llamadas activas o estadísticas de llamadas anteriores.
  • Controlar aspectos del sistema. Por ejemplo, puede agregar participantes a una llamada activa o emular la funcionalidad de control remoto.

 

En esta sección se proporciona una introducción a la API de Lifesize. Encontrará documentación más detallada en:

https://<DirecciónIPDelSistemaDeVídeo>/docs/clish (interfaz de la línea de comandos tradicional)

https://<DirecciónIPDelSistemaDeVídeo>/docs/json (API de REST)

Autenticación

Las mismas directivas de autenticación empleadas en los navegadores se aplican también a las llamadas a la API. Inicie sesión en el sistema de vídeo Lifesize a través de una conexión SSH o HTTP en la red del siguiente modo:

  1. Abra un cliente, como Cygwin o Putty, y escriba la dirección IP de su sistema de vídeo Lifesize.
  2. Inicie sesión en el sistema con credenciales de administrador. El nombre de usuario y la contraseña predeterminados son admin.

Sintaxis de comandos

Los comandos tienen esta forma:

<actor> <comando> <parámetros>

 

Utilice comas para separar diversos parámetros. Muestre la ayuda desde el indicador de comandos del siguiente modo:

help Muestra una breve introducción sobre el uso de la API.
Pulse la tecla Tabulador en el teclado Muestra una lista de actores.
<actor> ? Muestra los comandos para un actor. Por ejemplo:

audio ?

<actor> <comando> ? Muestra la ayuda sobre un comando. Por ejemplo:

sysadmin gettimezone ?