Send Chatroom Message

Users under the application can send messages to one or more specified chatrooms.

• Messages sent through this interface are not synchronized with the sender's client by default. For synchronization, refer to the isIncludeSender parameter usage.
• Supports sending messages to multiple chatrooms at once, but it is recommended not to exceed 10.

tip

• Through this interface, users can send messages to a chatroom even if they are not members.
• To send messages to all chatrooms under the application, use the Send Broadcast Message to All Chatrooms (/message/chatroom/broadcast.json) interface. For details, see Send Broadcast Message to All Chatrooms.

Request Method

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

Rate Limit: 100 messages per second, sending messages to 10 chatrooms at once counts as 10 messages.

Signature Rule: All server API requests must undergo rule verification. For details, see API Request Signature.

Body Parameters

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

Parameter	Type	Required	Description
fromUserId	String	Yes	Sender's user ID.
toChatroomId	String	Yes	Receiver chatroom ID. Providing multiple parameters allows sending messages to multiple chatrooms, but it is recommended not to exceed 10.
objectName	String	Yes	Accepts built-in message types (see Message Type Overview) or custom message type values. Note: For custom messages, the message type must not start with "RC:" to avoid conflicts with system built-in message types; the message type length must not exceed 32 characters. The SDK must have registered this custom message type, otherwise the SDK will not be able to parse the message upon receipt.
content	String	Yes	The content of the message to be 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, if the text message content JSON structure contains a content field (this is the key value within the JSON structure, please distinguish), the result of serializing {"content":"Hello world!"} should be used as the value of the content field here. Custom message types (objectName field must be specified as a custom message type): If sending a custom message, this parameter can be in a custom format, not limited to JSON.
isPersisted	Int	No	Whether to store this message in the historical message cloud storage service for the recipient. 0 means not stored; 1 means stored. The default value is 1, stored (dependent on Chatroom Message Cloud Storage Service). Generally (cases 1 and 2), whether the client stores the message does not depend on this parameter. The following case 3 is an exception: If the message belongs to a built-in message type, the client SDK will determine whether to store it in the local database based on the storage property identifier of the message type itself. See Message Type Overview. If the message belongs to a custom message type, the client SDK will determine whether to store it in the local database based on the storage property identifier when the type is registered on the client. If the message belongs to a custom message type not registered on the client App (e.g., the client is using an outdated App version), the client SDK will determine whether to store the message locally based on the current parameter value. However, since the message type is not registered, the client cannot parse and display the message. Note: The client will automatically clear the local chatroom historical message records when the user exits the chatroom.
isIncludeSender	Int	No	Whether to synchronize the sent message to the sender's client. 1 means synchronize, the default value is 0, meaning not synchronized. Note, setting this parameter alone cannot ensure that the sender's client will definitely receive the sent message, you may need to enable other services. For details, see How to Synchronize Sent Messages to Sender Client.
priority	Int	No	The priority level of this message, default is 0 if not passed, and the priority of this message follows the original logic setting. 1: Allowlist message (high message guarantee, requires enabling the chatroom allowlist function). 2: High priority message. 3: Low priority message (message is discarded first, requires enabling the chatroom message priority service).

Request Example

POST /message/chatroom/publish.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&toChatroomId=2192&toChatroomId=2193&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 is normal.
messageUIDs	Array	messageUID list
messageUIDs[i].userId	String	Chatroom ID, corresponds to the request toChatroomId
messageUIDs[i].messageUID	String	The unique ID of the message sent to the corresponding chatroom

Response Example

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

{
    "code": 200,
    "messageUIDs": [
        {
            "chatroomId": "2192",
            "messageUID": "XXXX-JJJJ-KKK-LLLL"
        },
        {
            "chatroomId": "2193",
            "messageUID": "XXXX-JJJJ-KKK-LLKL"
        }
    ]
}