Capítulo 6 GET POST

sendChatMessage – Enviar mensaje de chat

El endpoint sendChatMessage te permite enviar un mensaje de chat al chat público de una reunión en curso mediante la API. El mensaje aparece como un mensaje del sistema o con un nombre personalizado visible para todos los participantes. Este endpoint se introdujo en BigBlueButton 3.0.

Este endpoint solo está disponible en BigBlueButton 3.0 y posteriores. Está documentado de forma mínima en la documentación oficial de la API. Los detalles sobre códigos de error, limitación de tasa y codificación de caracteres no están especificados oficialmente. undocumented

Endpoint

GET https://api-guide.bbbserver.com/bigbluebutton/api/sendChatMessage?<parameters>&checksum=replace-with-checksum

Parámetros obligatorios

Parámetro Tipo Obligatorio Predeterminado Descripción
meetingID String Sí — El identificador de la reunión de destino.
message String Sí — El contenido del mensaje (de 1 a 500 caracteres). Los caracteres especiales se escapan automáticamente. HTML y Markdown no son compatibles.

Parámetros opcionales

Parámetro Tipo Obligatorio Predeterminado Descripción
userName String No System El nombre para mostrar del remitente (máximo 255 caracteres). undocumented

Ejemplo de solicitud

https://api-guide.bbbserver.com/bigbluebutton/api/sendChatMessage?meetingID=replace-with-meeting-id&message=Welcome+to+the+conference!&userName=System+Admin&checksum=replace-with-checksum

Respuesta de ejemplo

Una llamada correcta devuelve el siguiente XML: 

<response>
  <returncode>SUCCESS</returncode>
  <messageKey></messageKey>
  <message></message>
</response>

Respuestas de error

messageKey Descripción
checksumError El checksum no es válido.
missingParamMeetingID No se proporcionó el parámetro meetingID.
meetingNotFound La reunión no existe o ya no está en ejecución.
validationError Falta message, está vacío o supera los 500 caracteres; o userName supera los 255 caracteres.
En bbbserver.de, este endpoint está disponible en todos los planes que ejecutan BigBlueButton 3.0 o posterior. Puedes llamarlo usando tus credenciales de API que se encuentran en el panel de gestión del servidor.

Casos de uso

  • Envía mensajes de bienvenida automáticos cuando comienza una reunión.
  • Entrega notificaciones del sistema desde aplicaciones externas (p. ej., "La grabación comenzará en 5 minutos").
  • Crea integraciones de bots que reaccionen a eventos y publiquen mensajes.
  • Crea herramientas de moderación que envíen anuncios a todos los participantes.

Limitaciones

Ten en cuenta las siguientes restricciones al usar este endpoint:

  • Solo se admiten mensajes del chat público. No es posible enviar mensajes privados a usuarios individuales.
  • Sin formato Markdown ni HTML. El texto se representa solo como texto sin formato.
  • Los mensajes están limitados a 500 caracteres.
  • La reunión debe estar en ejecución. No se pueden enviar mensajes a reuniones finalizadas.
  • No se admite el envío de mensajes a salas de grupo.

Si necesitas enviar mensajes más largos, considera dividir el contenido en varias llamadas a la API. Ten en cuenta que las llamadas rápidas y sucesivas pueden estar sujetas a limitación de tasa, aunque los límites exactos no están documentados oficialmente.

Preguntas frecuentes

Este endpoint se introdujo en BigBlueButton 3.0. No está disponible en versiones anteriores como 2.6 o 2.7.

No. El endpoint sendChatMessage solo admite el chat público. Actualmente no existe ningún endpoint de API para enviar mensajes privados a participantes individuales.

La API devuelve una respuesta validationError. El mensaje no se envía. Debes acortar el texto a 500 caracteres o menos antes de volver a intentarlo.

No. El contenido del mensaje se trata como texto sin formato. Cualquier etiqueta HTML o sintaxis Markdown se mostrará literalmente en lugar de representarse.

Si no especificas un userName, el mensaje aparece con el nombre del remitente "System". Esto es adecuado para notificaciones automáticas y alertas del sistema.

No. El endpoint sendChatMessage solo se dirige a la sala principal de la reunión. El envío de mensajes a salas de grupos no es compatible con la API.