Kapitel 6 GET POST

sendChatMessage – Chatnachricht senden

Der Endpunkt sendChatMessage ermöglicht es Ihnen, über die API eine Chat-Nachricht an den öffentlichen Chat eines laufenden Meetings zu senden. Die Nachricht erscheint als Systemnachricht oder als Nachricht mit benutzerdefiniertem Namen und ist für alle Teilnehmenden sichtbar. Dieser Endpunkt wurde in BigBlueButton 3.0 eingeführt.

Dieser Endpunkt ist nur in BigBlueButton 3.0 und höher verfügbar. Er ist in der offiziellen API-Dokumentation nur minimal dokumentiert. Details zu Fehlercodes, Rate Limiting und Zeichenkodierung sind nicht offiziell spezifiziert. undocumented

Endpunkt

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

Erforderliche Parameter

Parameter Typ Erforderlich Standard Beschreibung
meetingID String Ja — Die Meeting-Kennung des Ziel-Meetings.
message String Ja — Der Inhalt der Nachricht (1 bis 500 Zeichen). Sonderzeichen werden automatisch maskiert. HTML und Markdown werden nicht unterstützt.

Optionale Parameter

Parameter Typ Erforderlich Standard Beschreibung
userName String Nein System Der Anzeigename des Absenders (maximal 255 Zeichen). undocumented

Beispielanfrage

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

Beispielantwort

Ein erfolgreicher Aufruf gibt das folgende XML zurück: 

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

Fehlerantworten

messageKey Beschreibung
checksumError Das checksum ist ungültig.
missingParamMeetingID Der Parameter meetingID wurde nicht angegeben.
meetingNotFound Das Meeting existiert nicht oder läuft nicht mehr.
validationError message fehlt, ist leer oder überschreitet 500 Zeichen; oder userName überschreitet 255 Zeichen.
Auf bbbserver.de ist dieser Endpunkt in allen Tarifen verfügbar, die BigBlueButton 3.0 oder höher ausführen. Sie können ihn mit Ihren API-Zugangsdaten aufrufen, die Sie im Server-Management-Dashboard finden.

Anwendungsfälle

  • Senden Sie automatische Willkommensnachrichten, wenn ein Meeting startet.
  • Übermitteln Sie Systembenachrichtigungen aus externen Anwendungen (z. B. „Die Aufzeichnung beginnt in 5 Minuten“).
  • Erstellen Sie Bot-Integrationen, die auf Ereignisse reagieren und Nachrichten posten.
  • Erstellen Sie Moderationswerkzeuge, die Ankündigungen an alle Teilnehmer senden.

Einschränkungen

Beachten Sie die folgenden Einschränkungen bei der Verwendung dieses Endpunkts:

  • Es werden nur öffentliche Chat-Nachrichten unterstützt. Das Senden privater Nachrichten an einzelne Benutzer ist nicht möglich.
  • Keine Markdown- oder HTML-Formatierung. Der Text wird nur als Klartext dargestellt.
  • Nachrichten sind auf 500 Zeichen begrenzt.
  • Das Meeting muss laufen. An beendete Meetings können keine Nachrichten gesendet werden.
  • Das Senden von Nachrichten an Breakout-Räume wird nicht unterstützt.

Wenn Sie längere Nachrichten senden müssen, sollten Sie den Inhalt auf mehrere API-Aufrufe aufteilen. Beachten Sie, dass schnell aufeinanderfolgende Aufrufe einer Ratenbegrenzung unterliegen können, obwohl die genauen Grenzwerte offiziell nicht dokumentiert sind.

Häufig gestellte Fragen

Dieser Endpunkt wurde in BigBlueButton 3.0 eingeführt. Er ist in früheren Versionen wie 2.6 oder 2.7 nicht verfügbar.

Nein. Der Endpunkt sendChatMessage unterstützt nur den öffentlichen Chat. Derzeit gibt es keinen API-Endpunkt, um private Nachrichten an einzelne Teilnehmende zu senden.

Die API gibt eine validationError-Antwort zurück. Die Nachricht wird nicht gesendet. Sie müssen den Text auf 500 Zeichen oder weniger kürzen, bevor Sie es erneut versuchen.

Nein. Der Nachrichteninhalt wird als Klartext behandelt. Alle HTML-Tags oder Markdown-Syntax werden wörtlich angezeigt, anstatt gerendert zu werden.

Wenn Sie keinen userName angeben, erscheint die Nachricht mit dem Absendernamen "System". Dies eignet sich für automatisierte Benachrichtigungen und Systemwarnungen.

Nein. Der Endpunkt sendChatMessage zielt nur auf den Hauptraum des Meetings ab. Das Senden von Nachrichten in Gruppenräume wird von der API nicht unterstützt.