Chapitre 6 GET POST

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). Les caractères spéciaux sont échappés automatiquement. HTML et Markdown ne sont pas pris en charge.

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). undocumented

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 n’a pas été fourni.
meetingNotFound La réunion n’existe pas ou n’est plus en cours.
validationError message est manquant, vide ou dépasse 500 caractères ; ou userName dépasse 255 caractères.
Sur bbbserver.de, ce point de terminaison est disponible dans tous les forfaits exécutant BigBlueButton 3.0 ou une version ultérieure. Vous pouvez l'appeler en utilisant vos identifiants API disponibles dans le tableau de bord de gestion du serveur.

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.
  • Aucun formatage Markdown ou HTML. Le texte est rendu uniquement en texte brut.
  • 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.
  • L’envoi de messages vers les salles de répartition n’est pas pris en charge.

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 validationError. Le message n'est pas envoyé. Vous devez raccourcir le texte à 500 caractères ou moins avant de réessayer.

Non. Le contenu du message est traité comme du texte brut. Toute balise HTML ou syntaxe Markdown sera affichée littéralement au lieu d'être rendue.

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.

Non. Le point de terminaison sendChatMessage cible uniquement la salle de réunion principale. L'envoi de messages dans les salles de répartition n'est pas pris en charge par l'API.