You are viewing the API documentation for BigBlueButton 3.x. The current version is BigBlueButton 4.x. Planning an upgrade? The migration guide lists every change your API calls need.
sendChatMessage – Send Chat Message
The sendChatMessage endpoint allows you to send a chat message to the public chat of a running meeting via the API. The message appears as a system or custom-named message visible to all participants. This endpoint was introduced in BigBlueButton 3.0.
This endpoint is only available in BigBlueButton 3.0 and later. It is minimally documented in the official API documentation. Details on error codes, rate limiting, and character encoding are not officially specified. undocumented
Endpoint
GET https://api-guide.bbbserver.com/bigbluebutton/api/sendChatMessage?<parameters>&checksum=replace-with-checksum Required Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
meetingID | String | Yes | — | The meeting identifier of the target meeting. |
message | String | Yes | — | The message content (1 to 500 characters). Markdown formatting is rendered; HTML tags are escaped and shown as plain text. |
Optional Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userName | String | No | System | The display name of the sender (maximum 255 characters). |
Example Request
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 Example Response
A successful call returns the following XML:
<response>
<returncode>SUCCESS</returncode>
<messageKey></messageKey>
<message></message>
</response> Error Responses
messageKey | Description |
|---|---|
checksumError | The checksum is invalid. |
missingParamMeetingID | The meetingID parameter is empty. |
meetingNotFound | The meeting does not exist or is no longer running, or the meetingID parameter was not provided. |
nullError | The message parameter was not provided. |
sizeError | A parameter is outside its allowed length: message 1–500 characters, meetingID 2–256 characters, userName at most 255 characters. |
validationError | The meetingID contains invalid characters (e.g. a comma). |
Use Cases
- Send automatic welcome messages when a meeting starts.
- Deliver system notifications from external applications (e.g. "Recording will begin in 5 minutes").
- Build bot integrations that react to events and post messages.
- Create moderation tools that send announcements to all participants.
Limitations
Be aware of the following restrictions when using this endpoint:
- Only public chat messages are supported. Sending private messages to individual users is not possible.
- HTML tags are escaped and shown as text; Markdown formatting (e.g. bold text or links) is rendered.
- Messages are limited to 500 characters.
- The meeting must be running. Messages cannot be sent to ended meetings.
- The message is posted only to the meeting given in
meetingID; it is not forwarded to that meeting's breakout rooms. - If
disabledFeaturescontainschat, the message is discarded although the call returnsSUCCESS.
If you need to send longer messages, consider splitting the content into multiple API calls. Keep in mind that rapid successive calls may be subject to rate limiting, although the exact limits are not officially documented.
Frequently Asked Questions
sendChatMessage endpoint only supports the public chat. There is currently no API endpoint for sending private messages to individual participants.sizeError response. The message is not sent. You must shorten the text to 500 characters or fewer before retrying.userName, the message appears with the sender name "System". This is suitable for automated notifications and system alerts.sendChatMessage posts only to the public chat of the meeting whose meetingID you pass. A message sent to the parent meeting is not forwarded to its breakout rooms.