Send Broadcast Message to All Chatrooms

With this API, you can send a broadcast message to all chatrooms under your application. Only users who are currently in the chatroom will receive this message; users who join later will not receive it.

• Chatroom Broadcast Messages cannot be stored in the server-side chatroom history (via the Cloud Storage for Chatroom Messages service).
• Chatroom Broadcast Messages cannot be used to maintain chatroom activity. To control the chatroom's lifespan, you can visit the Basic features page in the Console to adjust the chatroom destruction wait time. You can also use the Keepalive Chatroom API to dynamically set the chatrooms that need to be kept alive.
• By default, messages sent through this API will not be synchronized to the sender's client. If synchronization is required, please refer to the isIncludeSender parameter usage.

Enable the Service

Before using the Chatroom Broadcast Message feature, ensure that the service has been enabled for the current App Key. For details, refer to Message Management Service Configuration.

If the service is not enabled, the Server API will return a 1009 error. Note that if the API request frequency exceeds the limit due to continuous requests when the service is not enabled, the Server API will return an HTTP 429 Too Many Requests error (error code 1008).

Request Method

POST: https://Data Center Domain/message/chatroom/broadcast.json

Rate Limit: 1 request per second

Signature Rule: All server API requests require rule validation. For details, refer to API Request Signature.

Body Parameters

The HTTP request body data format is application/x-www-form-urlencoded, and it supports the following HTTP form parameters:

Parameter	Type	Required	Description
fromUserId	String	Yes	The sender's user ID.
objectName	String	Yes	Accepts built-in message types (see Message Type Overview) or custom message type values. Note: When using custom messages, the message type cannot start with "RC:" to avoid conflicts with system-built message types; the message type length cannot exceed 32 characters. The custom message must be registered in the SDK; otherwise, the SDK will not be able to parse the message upon receipt.
content	String	Yes	The content of the message being sent, with a maximum size of 128k per message. Built-in message types: Serialize the message content JSON object into a JSON string and pass it in. The message content JSON structure is detailed in User Content Message Format or other built-in message type formats. For example, the text message content JSON structure internally contains a content field (this is the key value within the JSON structure, please distinguish), so the serialized result of {"content":"Hello world!"} should be used as the value for the content field here. Custom message types (the objectName field must be specified as a custom message type): If sending a custom message, this parameter can be customized in any format, not limited to JSON.
isIncludeSender	Int	No	Whether to synchronize the sent message to the sender's client. 1 indicates synchronization. For details, refer to How to Sync Sent Messages to the Sender's Client. Note that this API only supports synchronizing sent messages when the sender is logged into the client (online). The default value is 0, meaning no synchronization.

Request Example

POST /message/chatroom/broadcast.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&objectName=RC:TxtMsg

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	Return Type	Description
code	Number	Return code, 200 for success.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}