Hoofdstuk 6 GET POST

sendChatMessage – Chatbericht verzenden

Met het endpoint sendChatMessage kun je via de API een chatbericht sturen naar de openbare chat van een actieve vergadering. Het bericht verschijnt als systeembericht of als bericht met een aangepaste naam dat zichtbaar is voor alle deelnemers. Dit endpoint werd geïntroduceerd in BigBlueButton 3.0.

Dit endpoint is alleen beschikbaar in BigBlueButton 3.0 en later. Het is minimaal gedocumenteerd in de officiële API-documentatie. Details over foutcodes, rate limiting en tekenencodering zijn niet officieel gespecificeerd. undocumented

Endpoint

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

Vereiste parameters

Parameter Type Vereist Standaard Beschrijving
meetingID String Ja — De vergaderingsidentificatie van de doelvergadering.
message String Ja — De inhoud van het bericht (1 tot 500 tekens). Speciale tekens worden automatisch geëscaped. HTML en Markdown worden niet ondersteund.

Optionele parameters

Parameter Type Vereist Standaard Beschrijving
userName String Nee System De weergavenaam van de afzender (maximaal 255 tekens). undocumented

Voorbeeldverzoek

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

Voorbeeldrespons

Een succesvolle aanroep retourneert de volgende XML: 

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

Foutresponses

messageKey Beschrijving
checksumError De checksum is ongeldig.
missingParamMeetingID De parameter meetingID is niet opgegeven.
meetingNotFound De vergadering bestaat niet of wordt niet meer uitgevoerd.
validationError message ontbreekt, is leeg of overschrijdt 500 tekens; of userName overschrijdt 255 tekens.
Op bbbserver.de is dit endpoint beschikbaar op alle pakketten die BigBlueButton 3.0 of later draaien. Je kunt het aanroepen met je API-inloggegevens die je vindt in het serverbeheerdashboard.

Toepassingen

  • Verstuur automatische welkomstberichten wanneer een vergadering start.
  • Lever systeemmeldingen vanuit externe applicaties af (bijv. "Opname begint over 5 minuten").
  • Bouw botintegraties die reageren op gebeurtenissen en berichten plaatsen.
  • Maak moderatietools die aankondigingen naar alle deelnemers sturen.

Beperkingen

Houd rekening met de volgende beperkingen bij het gebruik van dit endpoint:

  • Alleen openbare chatberichten worden ondersteund. Het versturen van privéberichten naar individuele gebruikers is niet mogelijk.
  • Geen opmaak met Markdown of HTML. De tekst wordt alleen als platte tekst weergegeven.
  • Berichten zijn beperkt tot 500 tekens.
  • De vergadering moet actief zijn. Berichten kunnen niet naar beëindigde vergaderingen worden gestuurd.
  • Het verzenden van berichten naar breakoutrooms wordt niet ondersteund.

Als je langere berichten moet verzenden, overweeg dan de inhoud op te splitsen in meerdere API-aanroepen. Houd er rekening mee dat snelle opeenvolgende aanroepen onderhevig kunnen zijn aan rate limiting, hoewel de exacte limieten niet officieel gedocumenteerd zijn.

Veelgestelde vragen

Dit endpoint werd geïntroduceerd in BigBlueButton 3.0. Het is niet beschikbaar in eerdere versies zoals 2.6 of 2.7.

Nee. Het endpoint sendChatMessage ondersteunt alleen de openbare chat. Er is momenteel geen API-endpoint om privéberichten naar individuele deelnemers te sturen.

De API retourneert een antwoord van het type validationError. Het bericht wordt niet verzonden. Je moet de tekst inkorten tot 500 tekens of minder voordat je het opnieuw probeert.

Nee. De inhoud van het bericht wordt als platte tekst behandeld. Eventuele HTML-tags of Markdown-syntaxis worden letterlijk weergegeven in plaats van gerenderd.

Als je geen userName opgeeft, verschijnt het bericht met de afzendernaam "System". Dit is geschikt voor geautomatiseerde meldingen en systeemwaarschuwingen.

Nee. Het endpoint sendChatMessage richt zich alleen op de hoofdvergaderruimte. Berichten versturen naar breakout rooms wordt niet ondersteund door de API.