API-Version: 4.x neueste 3.x

Sie sehen die API-Dokumentation für BigBlueButton 3.x. Die aktuelle Version ist BigBlueButton 4.x. Planen Sie ein Upgrade? Der Migrationsleitfaden listet alle erforderlichen Änderungen an Ihren API-Aufrufen auf.

Kapitel 6 GET

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 Nachrichteninhalt (1 bis 500 Zeichen). Markdown-Formatierung wird gerendert; HTML-Tags werden maskiert und als reiner Text angezeigt.

Optionale Parameter

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

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 ist leer.
meetingNotFound Die Konferenz existiert nicht oder läuft nicht mehr, oder der Parameter meetingID wurde nicht angegeben.
nullError Der Parameter message wurde nicht angegeben.
sizeError Ein Parameter liegt außerhalb der zulässigen Länge: message 1–500 Zeichen, meetingID 2–256 Zeichen, userName höchstens 255 Zeichen.
validationError meetingID enthält ungültige Zeichen (z. B. ein Komma).

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.
  • HTML-Tags werden maskiert und als Text angezeigt; Markdown-Formatierung (z. B. Fettdruck oder Links) wird gerendert.
  • Nachrichten sind auf 500 Zeichen begrenzt.
  • Das Meeting muss laufen. An beendete Meetings können keine Nachrichten gesendet werden.
  • Die Nachricht wird nur in der unter meetingID angegebenen Konferenz veröffentlicht; sie wird nicht an deren Breakout-Räume weitergeleitet.
  • Wenn disabledFeatures den Wert chat enthält, wird die Nachricht verworfen, obwohl der Aufruf SUCCESS zurückgibt.

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 sizeError-Antwort zurück. Die Nachricht wird nicht gesendet. Sie müssen den Text vor einem erneuten Versuch auf höchstens 500 Zeichen kürzen.

Markdown ja, HTML nein. Die Nachricht wird von Markdown in bereinigtes HTML umgewandelt: Formatierungen wie Fettdruck oder Links werden gerendert, während HTML-Tags maskiert und wörtlich angezeigt werden. Die offizielle Dokumentation sagt etwas anderes, aber der Quellcode rendert Markdown.

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

Nicht über die übergeordnete Konferenz. Breakout-Räume sind eigenständige Konferenzen, und sendChatMessage veröffentlicht Nachrichten nur im öffentlichen Chat der Konferenz, deren meetingID Sie übergeben. Eine an die übergeordnete Konferenz gesendete Nachricht wird nicht an deren Breakout-Räume weitergeleitet.