Unirse a una Sala

Punto final: /room/getJoinToken

Este punto final genera un token temporal que otorga a un usuario acceso a una sala específica. Antes de profundizar en los parámetros, es importante tener en cuenta algunos conceptos clave:

Ciclo de Vida del Token: El token generado es de corta duración (su período de validez se establece en la configuración de su servidor) y está diseñado para un único uso. Debe utilizarlo de inmediato, redirigiendo al usuario a la URL de la reunión. No almacene este token para uso futuro.
Unicidad del ID de Usuario:
- Plug-N-Meet requiere que cada participante en una sesión tenga un user_id único.
- Si usted creó la sala con auto_gen_user_id: false (el valor predeterminado), es su responsabilidad proporcionar un user_id único para cada usuario.
- Si un nuevo usuario se une con un user_id que ya está activo en la sala, el participante existente con ese ID será desconectado automáticamente. Esto es útil para permitir que los usuarios cambien de dispositivo sin interrupciones.
Existencia de la Sala: Solo puede generar un token de acceso para una sala que ya ha sido creada y que se encuentra activa.

Parámetros de la Solicitud

Campo	Tipo	Requerido	Descripción
room_id	string	Sí	El ID de la sala a la que desea unirse.
user_info	object	Sí	Información sobre el usuario que se unirá a la sala.

Información del Usuario

Campo	Tipo	Requerido	Descripción
name	string	Sí	El nombre que se mostrará para el usuario.
user_id	string	Sí	Un identificador único para el usuario. Nota: Si la sala se creó con `auto_gen_user_id: true`, este valor se almacenará como `ex_user_id` y se asignará un ID aleatorio al usuario para la sesión.
is_admin	boolean	Sí	Si es `true`, el usuario se unirá como moderador con privilegios elevados. Si es `false`, se unirá como un participante estándar.
is_hidden	boolean	No	Si es `true`, el usuario se unirá como espectador. No aparecerá en la lista de participantes y no podrá interactuar.
user_metadata	object	Sí	Metadatos adicionales sobre el usuario.

Metadatos del Usuario

Campo	Tipo	Requerido	Descripción
profile_pic	string	No	URL de la imagen de perfil del usuario.
preferred_lang	string	No	Idioma preferido para el cliente de Plug-N-Meet. Consulte los valores admitidos aquí. Ejemplo: es-ES, bn-BD, de-DE, etc.
record_webcam	boolean	No	Controla si la cámara web de este usuario se incluye en las grabaciones del lado del servidor. El valor predeterminado es `true`. Establézcalo en `false` para excluirla.
ex_user_id	string	No	Si está vacío, se utilizará el valor de `user_id`.
extra_data	map	No	Un mapa de pares clave-valor personalizados. Tanto las claves como los valores deben ser cadenas de texto. Por ejemplo: `{"key": "value"}`
lock_settings	object	No	Configuraciones de bloqueo para el usuario.

Ejemplo

{
  "room_id": "sala01",
  "user_info": {
    "name": "Su Nombre",
    "user_id": "Su-ID-de-Usuario-Unico",
    "is_admin": true,
    "is_hidden": false,
    "user_metadata": {
      "profile_pic": "https://profile.pic/im.jpg",
      "lock_settings": {
        "lock_microphone": false,
        "lock_webcam": false,
        "lock_screen_sharing": true,
        "lock_chat": false,
        "lock_chat_send_message": false,
        "lock_chat_file_share": false
      }
    }
  }
}

Respuesta

Campo	Tipo	Posición	Descripción
status	boolean	raíz	Indica si la solicitud fue exitosa.
msg	string	raíz	Mensaje de respuesta.
status_code	string	raíz	Código de estado de la respuesta.
token	string	raíz	El token de acceso.

Uso del Token de Acceso

Una vez que reciba el token, puede otorgar al usuario acceso a la sala de reuniones. Hay dos formas de pasar el token al cliente de Plug-N-Meet:

Como un parámetro de URL (recomendado): Pase el token en la cadena de consulta como access_token.
Como una cookie: Establezca una cookie llamada pnm_access_token con el token como su valor.

El método del parámetro de URL es el más sencillo. A continuación, un ejemplo:

https://Su-Servidor-Plug-N-Meet.com/?access_token=<TOKEN_AQUÍ>

Si usted está alojando los archivos estáticos de plugNmeet-client en otro lugar, también debe pasar el token de la misma manera. Por ejemplo, si sus archivos estáticos están en un directorio conference:

https://Su-Dominio.com/conference/?access_token=<TOKEN_AQUÍ>

Nota: También puede usar la API getClientFiles para recuperar todos los archivos CSS y JS necesarios para mostrar la interfaz manualmente. Esto le permite incrustar el cliente de Plug-N-Meet en cualquier lugar sin preocuparse por los archivos de compilación estáticos.

Diseño Personalizado

Puede agregar un parámetro de consulta adicional llamado custom_design al enlace de acceso para aplicar un diseño único para cada usuario. El valor de custom_design debe ser una cadena JSON codificada para URL.

Para obtener una lista completa de los parámetros admitidos y sus descripciones, consulte la sección Parámetros de Diseño en nuestra Guía para Desarrolladores.

Ejemplo:

https://Su-Dominio.com/conference/?access_token=<TOKEN_AQUÍ>&custom_design=%7B%22primary_color%22%3A%22%23004D90%22%2C%22secondary_color%22%3A%22%2324AEF7%22%7D

Parámetros de la Solicitud​

Información del Usuario​

Metadatos del Usuario​

Ejemplo​

Respuesta​

Uso del Token de Acceso​

Diseño Personalizado​