Descripción general

La solución de archivado de reuniones y seminarios web de Zoom permitirá que los administradores de cuentas configuren un mecanismo automatizado para recopilar y archivar los datos de las reuniones en una plataforma de terceros de su elección y, por consiguiente, cumplir con FINRA u otros requisitos de cumplimiento. El enfoque de Zoom para desarrollar esta solución es independiente de la plataforma, lo que permite que los clientes realicen el archivado en cualquier plataforma de terceros con un punto de conexión definido.

A diferencia de la grabación en la nube, que guarda archivos de vídeo, audio y chat/transcripción en la nube de Zoom, la API de archivado recopila datos y metadatos de seminarios web y reuniones necesarios para ciertas pautas de cumplimiento, así como los archivos de audio, vídeo y chat si se establecen en la llamada a la API.

Este artículo trata sobre:

• Ámbito
  • Detalles del ámbito de las reuniones de Zoom
  • Detalles de ámbito de los seminarios web de Zoom
  • Detalles del ámbito de las reuniones y los seminarios web de Zoom
• Procedimiento para la habilitación
• Flujo general
• Información de la API
  • Resumen
  • Contenido del archivado
  • Metadatos de la reunión
• interfaz de usuario
  • Página de configuración
  • Página del panel de control
• Deshabilitación la función de archivado

Requisitos previos

• Póngase en contacto con el soporte para habilitar el archivado de reuniones para su cuenta
• Se necesita un entorno de terceros para enviar contenido para archivado (es decir, Zoom no almacenará el contenido del archivado).
• Se necesita una aplicación de Marketplace (podría ser recientemente desarrollada o utilizada a partir de aplicaciones existentes)
• Zoom Desktop Client
  • Windows: 5.4.0 o posterior
  • macOS: 5.4.0 o posterior
  • Linux: 5.4.0 o posterior
• Aplicación móvil de Zoom
  • Android: 5.4.0 o posterior
  • iOS: 5.4.0 o posterior

Ámbito

Este producto solo incluye el contenido de archivado de las reuniones de Zoom y los seminarios web de Zoom (es decir, el contenido de Zoom Phone, Rooms y otros productos no reunirá los requisitos para el archivado mediante esta solución).

Nota: Actualmente, las salas de grupos pequeños, las reacciones en la reunión, los subtítulos ocultos, las preguntas y respuestas y las Zoom Rooms no son compatibles con el archivado.

Detalles del ámbito de las reuniones de Zoom

Las reuniones con cifrado optimizado se admitirán para el archivado, pero las reuniones cifradas de extremo a extremo no se admiten en este momento.

La siguiente información de las reuniones estará disponible para archivar:

• Metadatos de la reunión (obligatorio): incluye el tema, la fecha, la zona horaria, la duración de la reunión, el nombre de anfitrión, la ID de la reunión, la ID única (UUID) y la clave de acceso.
• Mensajes de chat durante la reunión: el nombre para mostrar del usuario, la dirección de correo electrónico del usuario (solo si un usuario ha iniciado sesión), la etiqueta para diferenciar el chat público del directo, la cadena de mensajes y la marca de tiempo.
• Votaciones: preguntas y respuestas, nombre de la respuesta automática para cada respuesta, dirección de correo electrónico de la respuesta automática para cada respuesta.
• Audio/vídeo: archivos de audio y vídeo independientes.
• Pizarra y anotación: disponibles como parte del archivo de vídeo.

Detalles de ámbito de los seminarios web de Zoom

La siguiente información de los seminarios web estará disponible para archivar:

• Metadatos del seminario web (obligatorio): incluye el tema, la fecha, la zona horaria, la duración de la reunión, el nombre de anfitrión, la ID de la reunión, la ID única (UUID) y la clave de acceso.
• Mensajes de chat durante el seminario web: el nombre para mostrar del usuario, la dirección de correo electrónico del usuario (solo si ha iniciado sesión) y los chats públicos (para asistentes y panelistas).
• Audio/vídeo: archivos de audio y vídeo independientes.
• Pizarra y anotación: disponibles como parte del archivo de vídeo.

Detalles del ámbito de las reuniones y los seminarios web de Zoom

Solo se archivarán las reuniones y los seminarios web organizados por usuarios marcados para el cumplimiento. Esto significa que, si estos usuarios se unieron como participantes a menos que el organizador de la reunión o el seminario web también esté marcado para el archivado, el contenido del usuario no se archivará.

Nota sobre la dependencia de la plataforma:

Para los usuarios del cliente anterior, el agente de archivado no podrá recopilar mensajes privados del chat durante la reunión hacia este cliente y provenientes de él. Todos los demás datos se pueden recopilar. Además, los usuarios de un cliente anterior no verán un icono que indique que se está archivando la reunión o el seminario web. Por estos motivos, se recomienda que todos los usuarios de la reunión estén en la versión 5.4.0 o posterior del cliente de Zoom.

Procedimiento para la habilitación

1. Inicie una aplicación de Marketplace y obtenga una ID de aplicación.
   Nota: Omita este paso si está utilizando una aplicación existente en Marketplace.
2. Póngase en contacto con el soporte de Zoom para hacer lo siguiente:
   • Habilitar el archivado de las reuniones para su cuenta para asegurarse de que se pueden usar las funciones de archivado. Para ello, póngase en contacto con Soporte y solicite que se habilite "Archivado de reuniones y seminarios web" para su cuenta. Al realizar su solicitud para habilitar la función, también deberá informarle a Soporte el tiempo de almacenamiento de los datos archivados. Los datos de archivo de reuniones y seminarios web se guardarán durante 7 días antes de su eliminación.
   • Proporcionar la ID de la aplicación de Marketplace para asegurarse de que la aplicación puede suscribirse a las notificaciones de eventos de webhook.
     Nota: Esto solo es necesario si está desarrollando la aplicación. La finalidad de este paso es asegurarse de que las API no sean utilizadas por participantes no deseados.
3. Complete la aplicación de Marketplace con la información de la API proporcionada.
   Nota: Omita este paso si está utilizando una aplicación existente en Marketplace.
   • Introduzca los puntos de conexión del sistema de terceros (es decir, si el entorno de terceros se basa en un servidor SMTP, configure la dirección IP del servidor y el correo electrónico del dominio). Se recomienda intentarlo primero con una instancia de prueba y, a continuación, trasladarla a una instancia de producción.
   • Introduzca los datos de acceso de la instancia de archivo de terceros (es decir, para el ejemplo del servidor SMTP, se trataría de una credencial de acceso a la instancia SMTP).
   • Configure un panel de control para realizar un seguimiento de los detalles de envío del contenido.
4. Publique la aplicación de Marketplace como privada para su organización o pública para todos los usuarios.
   Nota: Si usted es un desarrollador de terceros que busca exponer esta aplicación para que más clientes la adopten, puede hacer que sea pública. Si es un cliente de Zoom que está desarrollando esta aplicación para su propio uso, puede hacer que la aplicación sea privada para su organización.

Flujo general

La solución de Zoom de archivado de reuniones tiene tres componentes clave:

• Aplicación de Marketplace: la crea un desarrollador (ya sea el cliente de Zoom o un desarrollador de terceros) y la configura el administrador de la cuenta. La finalidad de esta aplicación es conectar Zoom y la plataforma de archivado de terceros. En esta aplicación, los clientes pueden especificar el contenido que necesitan para fines de archivo, los usuarios que necesitan archivado de cumplimiento y el punto de conexión de la configuración. Si existe integración con una plataforma de terceros en nuestro Marketplace, esto se puede usar para el archivado o los administradores pueden crear una aplicación siguiendo la información de la API que se muestra más adelante en este artículo. Una vez que se realiza la configuración de archivado, esta aplicación también se puede utilizar para mostrar un panel de control básico que muestra si la actividad de archivado se realizó correctamente desde el lado de Zoom. Esto es útil para los esfuerzos de compatibilización básica.
• Agente de archivo: este componente será responsable de recopilar y reenviar el contenido al punto de conexión de terceros, tal como se define en la aplicación de Marketplace. Con la implementación actual, este agente se aloja dentro de los servidores de Zoom y se puede considerar un participante bot que se une a la reunión. La presencia del agente queda clara en la interfaz de usuario del cliente con un icono de archivado.  
  Nota: Actualmente, el cliente de VDI (Infraestructura de escritorio virtual) y el cliente Zoom Rooms no muestran el icono de archivo.
• Plataforma de terceros: puede ser cualquier proveedor que disponga de un ecosistema de API abierto para ingerir el contenido de archivo de reuniones de forma adecuada. También pueden ser soluciones internas creadas por los clientes. En resumen, siempre que la plataforma tenga un punto de conexión público, puede configurarse a través de la aplicación de Marketplace.
  Nota: Esta solución es de naturaleza genérica para garantizar que se puedan considerar diversas plataformas de terceros para los casos de uso del archivado.

Relación entre estos tres componentes:

1. Configure la aplicación de Marketplace para conectarse con la plataforma de terceros.
   Nota: Asegúrese de que la aplicación esté suscrita al webhook recording.archive_files_completed.
2. El agente de archivo se une a las reuniones y recopila información por configuración.
3. Una vez finalizada la reunión, el agente de archivo notifica a la aplicación de Marketplace que el archivado se ha completado.
4. La aplicación de Marketplace recuperará la información que se va a archivar.
5. La aplicación de Marketplace enviará este contenido a la plataforma de terceros (nota: el desarrollador puede definir el formato de archivo para enviar esta información. También se pueden usar los formatos de archivo estándar de la plataforma Zoom, por ejemplo, los mensajes de chat en la reunión estarán en un archivo .txt y el archivo de vídeo estará en .mp4).
6. (Opcional) La aplicación de Marketplace actualiza su panel de control e indica que la información se ha enviado a la plataforma de terceros (solo si el desarrollador crea un panel de control).
7. La plataforma de terceros ingiere esta información y aplica lógica de negocio para gestionar los datos.
   Nota: Zoom no interviene en este paso.

Información de la API

Esta sección muestra una breve descripción para que los desarrolladores de aplicaciones de Marketplace (en este caso, el cliente o el propio proveedor de archivos de terceros) desarrollen la aplicación de archivo de reuniones.

Para esta sección, supondremos que el desarrollador ya tiene el concepto de desarrollo de la aplicación de Marketplace de Zoom. Consulte este documento para obtener contexto sobre la API de Zoom y las suscripciones de webhook.

Hay 3 API necesarias que son específicas del archivado de reuniones. Además, el desarrollador puede aprovechar otra API de Zoom abierta para agregar lógica de negocio o funciones a esta aplicación.

Nota: Estas API no se publican en nuestro Marketplace para garantizar que el acceso solo se proporcione a los clientes y los desarrolladores que tengan la intención de usar estas API solo para la fines de archivado. Póngase en contacto con Soporte de Zoom con su ID de aplicación para que podamos permitir el acceso a esta API.

Resumen

• Para especificar los detalles de archivado de la reunión o el seminario web, la aplicación debe llamar a la API: /v2/accounts/{accountId}/settings.
• Para obtener información de votaciones, la aplicación debe llamar a la API:/past_meetings/{meetingId}/polls.
• Para el vídeo, el audio y el chat durante la reunión, la aplicación debe llamar al evento de webhook: recording.archive_files_completed.

Contenido del archivado

• /v2/accounts/{accountId}/settings: llame a esta API para obtener y establecer los detalles de archivado de las reuniones o los seminarios web para la cuenta. El campo “archiving_type” admitirá la opción de archivar solo reuniones, solo seminarios web o reuniones y seminarios web para la fuente de contenido que se va a archivar. Consulte el modelo de datos a continuación:

  {
      "recording": {
          ...
          "archive":{
              "enable":"boolean",
              "settings":{
                  "chat_file":"boolean",
                  "audio_file":"boolean",
                  "video_file":"boolean"
                  "archiving_type":"number" [0: meeting, 1: webinar, 2: meeting and webinar]
              }
          }
      }
  }

• /past_meetings/{meetingId}/polls: llame a la API de votaciones para descargar los resultados de las votaciones.

Metadatos de la reunión

• recording.archive_files_completed: la aplicación de Marketplace debe estar configurada para suscribirse a este evento. Esto se puede hacer cuando la aplicación se configura a través de la interfaz de usuario del portal de Marketplace. A continuación se muestra la estructura de carga útil:
  

    "event": "string",
    "payload": {
      "account_id": "string",
      "object": {
        "id": "string",
        "uuid": "string",
        "host_id": "string",
        "topic": "string",
        "type": "integer",
        "start_time": "string",
        "timezone": "string",
        "duration": "integer",
        "share_url": "string",
        "total_size": "integer",
        "recording_count": "integer",
        "host_email": "string",
        "password": "string",
        "archive_files": [
          {
            "id": "string",
            "file_type": "string",
            "file_size": "number",
            "download_url": "string",
            "status": "string",
            "recording_type": "string"
          }
        ]
      }
    }
  }

Interfaz de usuario

El desarrollador debe proporcionar una página web de configuración en la aplicación de Marketplace para que el administrador configure los puntos de conexión, proporcione credenciales de acceso, especifique el contenido marcado para el archivado y defina el ámbito (es decir, para grupos de usuarios específicos o todos los usuarios). Los archivos de chat de vídeo/audio/durante la reunión deben enviarse a través de la API y las demás opciones deben ser almacenadas por la aplicación localmente en el servicio del anfitrión.

Página de configuración

Nota: Esto es necesario para configurar y utilizar las características de archivado/API.

Los desarrolladores pueden usar esta página para permitir que los administradores de Zoom especifiquen el contenido exacto que se archivará para su cuenta. Los metadatos de la reunión se recopilarán para todas las aplicaciones configuradas y es conveniente dejar esto claro en la página de configuración. Para las otras opciones, se recomienda proporcionar una selección al administrador para que la información relevante se pueda marcar para el archivado.

Nota: Los dibujos y las anotaciones de la pizarra están disponibles a través del propio archivo de vídeo. Si esto es importante, podría señalarse a través de información sobre herramientas.

Página del panel de control

Nota: Esto no es necesario para la configuración; sin embargo, Zoom recomienda que los desarrolladores agreguen un panel de control para fines de compatibilización de datos.

Una vez que la aplicación de Marketplace recibe la notificación de webhook, la aplicación puede almacenar los metadatos de la reunión y puede mostrar un estado de la transferencia de datos. Esto refleja el resultado del envío del contenido marcado para archivar a la plataforma de terceros. Los metadatos de la reunión y el estado serán mantenidos por la propia aplicación de Marketplace.

Para crear un panel de control, el desarrollador deberá preparar una página web en la aplicación de Marketplace (no mantenida por Zoom). En esta página web, los desarrolladores pueden mostrar cualquier contenido que deseen para un panel de control (es decir, una tabla que muestra un registro de todas las reuniones y el estado de la transferencia de datos de "éxito" o "error").

Deshabilitación la función de archivado

La API de archivado se puede deshabilitar quitando la aplicación de Marketplace o la aplicación personalizada desarrollada en su cuenta de Marketplace. La función de archivado también se puede deshabilitar en toda la cuenta; para ello, póngase en contacto con Soporte y solicite que se deshabilite "Archivado de reuniones y seminarios web".