Crear y personalizar reuniones
La Meetings API le permite integrar en sus aplicaciones web reuniones de vídeo interactivas en tiempo real y de alta calidad. Ideal para quienes desean reuniones plug and play con una personalización limitada, basta con unas pocas líneas de código para generar una reunión e incrustarla en su aplicación.
En este caso de uso, elaborará una solicitud cURL para crear una sala de reuniones personalizada para su aplicación.
Para ello, repasaremos las opciones disponibles a la hora de crear una reunión:
- Crear una petición básica - comience con una solicitud cURL para una sala de reuniones básica.
- Configurar la aprobación de las uniones - Establezca el nivel de aprobación necesario para participar en la reunión.
- Localización - Seleccione el idioma que desea mostrar en la interfaz de usuario.
- Elija las funciones que desea activar - Activar / desactivar las opciones de grabación, chat y pizarra.
- Cambie el tema de su reunión - Aplique un tema personalizado, si es necesario.
- Ejecutar la solicitud - crear la reunión En este punto, la reunión está lista para su uso, pero también puede seguir el siguiente paso para incrustar su reunión.
- Integrar la reunión en su aplicación - cree un iFrame para integrar su reunión en su sitio web o aplicación.
Requisitos previos
Para completar el tutorial, necesitas:
Cuenta de desarrollador de Vonage: Si aún no tiene una, regístrese para obtener una Account gratuita en el Cuenta de desarrollador de Vonage.
Identificación y secreto de la solicitud: Una vez iniciada la sesión en Panel de API de VonageHaga clic en Applications y cree una nueva Application. Haga clic en
Generate public and private keyy registre la clave privada. Utilizará la clave privada con el ID de la aplicación para Generar un token web JSON (JWT). Para más información sobre los JWT, consulte Autenticación. Asegúrese también de que la Meetings API está activada para su aplicación en "Capacidades" e introduzca su contraseña. URL de webhooks:
Crear una petición básica
Para empezar, se puede utilizar la siguiente solicitud cURL para crear una sala de reuniones básica con las opciones predeterminadas:
En las siguientes secciones se detallan los ajustes que se pueden utilizar para personalizar la sala de reuniones.
Configurar la aprobación de las uniones
join_approval_level se puede utilizar para establecer el nivel de aprobación necesario para unirse a la reunión. Debe establecerse como uno de los siguientes:
after_owner_only- Los participantes se incorporarán a la reunión sólo después de que lo haya hecho el anfitrión.explicit_approval- Los participantes se incorporarán a la sala de espera, y el anfitrión los aprobará / denegará.none- No necesita aprobación.
Por ejemplo, puede que desee configurar la sala de reuniones para que los participantes permanezcan en una sala de espera hasta que el propietario apruebe la entrada. Para ello, añada join_approval_level a la solicitud de la siguiente manera:
Localización
El idioma de la interfaz de usuario puede cambiarse de dos maneras:
- Predefinido en la llamada a la API: permite predefinir el idioma para todos los participantes en la reunión a través de una opción en la llamada a la API.
- Selección desde la interfaz de usuario: añade una opción de selección de idioma a la interfaz de usuario que permite a cada participante en la reunión seleccionar su idioma preferido.
En este tutorial utilizaremos la llamada a la API para aplicar un idioma a todos los participantes; consulte la guía sobre Localización para más información sobre el conmutador de IU.
Para establecer un idioma, añada un ui_settings a su llamada API que contenga el language. En este ejemplo, aplicaremos el inglés, pero puede utilizar cualquiera de los idiomas idiomas admitidos:
Elija las funciones que desea activar
Hay varias funciones que pueden activarse o desactivarse para sus reuniones:
- Grabación: Muestra la opción de grabación en la interfaz de usuario para la reunión. Configurar con
is_recording_available. - Pizarra: Muestra la opción para encender la pizarra. Configurar con
is_whiteboard_available. - Chat: Activa la función de chat. Configurar con
is_chat_available.
En este ejemplo, activaremos cada una de estas funciones añadiendo el parámetro available_features a la llamada a la API:
Cambie el tema de su reunión
Las reuniones pueden personalizarse con temas para utilizar diferentes colores, logotipos o textos. En primer lugar, deberá crear un tema siguiendo la guía que encontrará aquí. theme_id que puede utilizar para aplicar el tema al crear una reunión:
Ejecutar la solicitud
Una vez configuradas todas las personalizaciones, es hora de ejecutar la solicitud. Recibirá una devolución de llamada con toda la información de la reunión, incluido el ID de la reunión y las URL necesarias para participar como anfitrión e invitado:
En este punto, la reunión está lista para su uso. Los siguientes pasos cubren algunos parámetros adicionales que pueden añadirse a las URL de su reunión, junto con instrucciones para incrustar su reunión en un sitio web o aplicación.
Parámetros URL
También puede añadir algunos parámetros opcionales a las URL de su reunión para activar/desactivar diferentes funcionalidades:
| Parámetro | Efecto | Valores |
|---|---|---|
skip_prejoin | Determina si un usuario ve la pantalla de pre-unión o entra directamente en la reunión. | true o false |
user_display_name | Define el nombre que tiene un participante en la reunión. | Texto |
blur_on | El desenfoque del fondo se activa automáticamente al entrar en la reunión. | true o false |
blur_enabled | Si se desactiva, los participantes en la reunión no pueden activar o desactivar el fondo borroso: el botón desaparece de la interfaz de usuario de la reunión. | true o false |
background_enabled | Si se desactiva, los participantes en la reunión no pueden cambiar su fondo: el botón desaparece de la interfaz de usuario de la reunión. | true o false |
layout | Establece un diseño predeterminado para la reunión. | gallery: muestra todas las pantallas disponibles.  audience: muestra al presentador principal (orador o pantalla compartida) en el centro, con todos los demás participantes a la derecha.  dominant: Sólo muestra el presentador principal (altavoz o pantalla compartida).  |
URL del host
Para añadirlo a una URL de host, añada los parámetros después del carácter ? - por ejemplo, para utilizar el diseño Audiencia y saltarse la pantalla previa a la unión con esta URL:
https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC
Deberías añadir los siguientes parámetros:
https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC&skip_prejoin=true&layout=audience
URL para invitados
Para utilizar estos parámetros con la función guest_url devuelto en la llamada de retorno, debe añadir ?room_token= antes de la identificación de la sala.
Por ejemplo, https://meetings.vonage.com/280674154 se convertiría en https://meetings.vonage.com/?room_token=280674154. A continuación, puede añadir otros parámetros a la lista según sea necesario.
Integrar la reunión en su aplicación
Puede utilizar un iFrame para incrustar su reunión en su sitio web o aplicación. Sustituir GUEST_URL en el siguiente código con la URL de su reunión:
Esto insertará la reunión en la aplicación y solicitará al usuario permisos para la cámara y el micrófono. Existen algunas limitaciones en las funciones disponibles en función del tamaño de su iFrame, que se detallan a continuación aquí.
También deberá enviar una solicitud por correo electrónico a la dirección Equipo Meetings API para etiquetar el dominio del sitio web en el que se utiliza el iFrame.
Conclusión
En este tutorial, ha creado una reunión utilizando la Meetings API, adaptada a sus necesidades. Para obtener más información sobre la Meetings API, incluida la gestión de salas de reuniones e información sobre las devoluciones de llamada, consulte la sección Lecturas complementarias a continuación.