Version de l’API: 4.x dernière version 3.x

Vous consultez la documentation de l’API pour BigBlueButton 3.x. La version actuelle est BigBlueButton 4.x. Vous prévoyez une mise à niveau ? Le guide de migration répertorie toutes les modifications à apporter à vos appels API.

Chapitre 6 GET

sendChatMessage – Envoyer un message de chat

Le point de terminaison sendChatMessage vous permet d'envoyer un message dans le chat public d'une réunion en cours via l'API. Le message apparaît comme un message système ou un message à nom personnalisé visible par tous les participants. Ce point de terminaison a été introduit dans BigBlueButton 3.0.

Ce point de terminaison est disponible uniquement dans BigBlueButton 3.0 et les versions ultérieures. Il est documenté de manière minimale dans la documentation API officielle. Les détails sur les codes d'erreur, la limitation de débit et l'encodage des caractères ne sont pas officiellement spécifiés. undocumented

Point de terminaison

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

Paramètres requis

Paramètre Type Obligatoire Par défaut Description
meetingID String Oui — L’identifiant de la réunion cible.
message String Oui — Le contenu du message (de 1 à 500 caractères). La mise en forme Markdown est appliquée ; les balises HTML sont échappées et affichées en texte brut.

Paramètres facultatifs

Paramètre Type Obligatoire Par défaut Description
userName String Non System Le nom d’affichage de l’expéditeur (255 caractères maximum).

Exemple de requête

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

Exemple de réponse

Un appel réussi renvoie le XML suivant :

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

Réponses d’erreur

messageKey Description
checksumError Le checksum est invalide.
missingParamMeetingID Le paramètre meetingID est vide.
meetingNotFound La réunion n’existe pas ou n’est plus en cours, ou le paramètre meetingID n’a pas été fourni.
nullError Le paramètre message n’a pas été fourni.
sizeError La longueur d’un paramètre est hors des limites autorisées : message de 1 à 500 caractères, meetingID de 2 à 256 caractères, userName au maximum 255 caractères.
validationError meetingID contient des caractères non valides (par exemple, une virgule).

Cas d’usage

  • Envoyez des messages de bienvenue automatiques au démarrage d’une réunion.
  • Diffusez des notifications système depuis des applications externes (par ex. « L’enregistrement commencera dans 5 minutes »).
  • Créez des intégrations de bots qui réagissent aux événements et publient des messages.
  • Créez des outils de modération qui envoient des annonces à tous les participants.

Limitations

Tenez compte des restrictions suivantes lors de l’utilisation de ce point de terminaison :

  • Seuls les messages du chat public sont pris en charge. Il n’est pas possible d’envoyer des messages privés à des utilisateurs individuels.
  • Les balises HTML sont échappées et affichées sous forme de texte ; la mise en forme Markdown (par exemple, du texte en gras ou des liens) est appliquée.
  • Les messages sont limités à 500 caractères.
  • La réunion doit être en cours. Il est impossible d’envoyer des messages à des réunions terminées.
  • Le message est publié uniquement dans la réunion indiquée dans meetingID ; il n’est pas transmis aux salles de sous-groupes de cette réunion.
  • Si disabledFeatures contient chat, le message est ignoré, même si l’appel renvoie SUCCESS.

Si vous devez envoyer des messages plus longs, envisagez de diviser le contenu en plusieurs appels API. Gardez à l'esprit que des appels rapides et successifs peuvent être soumis à une limitation de débit, bien que les limites exactes ne soient pas officiellement documentées.

Foire aux questions

Ce point de terminaison a été introduit dans BigBlueButton 3.0. Il n'est pas disponible dans les versions antérieures telles que 2.6 ou 2.7.

Non. Le point de terminaison sendChatMessage prend uniquement en charge le chat public. Il n'existe actuellement aucun point de terminaison API pour envoyer des messages privés à des participants individuels.

L’API renvoie une réponse sizeError. Le message n’est pas envoyé. Vous devez raccourcir le texte à 500 caractères maximum avant de réessayer.

Markdown oui, HTML non. Le message est converti de Markdown en HTML assaini : la mise en forme, comme le texte en gras ou les liens, est appliquée, tandis que les balises HTML sont échappées et affichées telles quelles. La documentation officielle affirme le contraire, mais le code source applique la mise en forme Markdown.

Si vous ne spécifiez pas de userName, le message apparaît avec le nom d'expéditeur "System". Cela convient aux notifications automatisées et aux alertes système.

Pas par l’intermédiaire de la réunion principale. Les salles de sous-groupes sont des réunions distinctes, et sendChatMessage publie uniquement dans la discussion publique de la réunion dont vous transmettez le meetingID. Un message envoyé à la réunion principale n’est pas transmis à ses salles de sous-groupes.