Send One-to-One Chat Status Message

Users within an application can send one-to-one chat status messages to other users. Messages sent through this interface can only be received when the recipient is online. If the recipient is currently offline, they will not receive this message.

• Messages sent through this interface are not synchronized to the sender's client by default. If synchronization is required, please refer to the isIncludeSender parameter usage.
• A maximum of 1000 users can be sent messages at once.

About One-to-One Chat Status Messages

The server provides a one-to-one chat status message interface /statusmessage/private/publish.json. Any type of message sent through this interface has the following characteristics:

• Only online recipient users will receive this message.
• The message is not counted or stored on the server. Therefore, if the recipient is currently offline, they will not receive this message again, nor can they retrieve it from the server's historical messages.
• Post-messaging callback is not supported by default.

When the mobile client receives messages sent through this interface, it processes them in the same way as other group chat messages, determining whether to count them as unread messages or store them locally based on the storage and counting properties of the message type itself. For information on the storage and counting properties of predefined message types in the IM service, refer to Message Type Overview. If you are sending a custom message type, you need to pay attention to the specific counting and storage properties of that custom message type in the client.

Request Method

POST: https://Data Center Domain/statusmessage/private/publish.json

Rate Limit: A maximum of 6000 messages can be sent per minute, with a maximum of 1000 target users per request. Note that sending to 1000 users at once counts as 1000 messages.

Signature Rule: All server API requests require rule validation. 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	The sender's user ID.
toUserId	String	Yes	The recipient's user ID. Supports sending messages to multiple users, with a maximum of 1000 users per request.
objectName	String	Yes	The message type, which accepts built-in message types (see Message Type Overview) or custom message type values. Note: When using 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 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, if the text message content JSON structure contains a content field (this is the key value within the JSON structure, note the distinction), then 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 specify a custom message type): If sending a custom message, this parameter can be customized in any format, not limited to JSON.
verifyBlacklist	Int	No	Whether to filter the sender's blocklist, where 0 means no filtering and 1 means filtering. The default is 0 (no filtering).
isIncludeSender	Int	No	Whether to synchronize the sent message to the sender's client. 1 means synchronize, and the default value is 0, meaning no synchronization. Note that this interface is used to send status messages, so synchronization is only supported when the sender is logged into the client (online).

Request Example

POST /statusmessage/private/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&toUserId=2191&toUserId=2192&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 indicates success.
messageUIDs	Array	Returns a list of messageUIDs
messageUIDs[i].userId	String	The recipient's user ID, corresponding to the request's toUserId
messageUIDs[i].messageUID	String	The unique ID of the message sent to the corresponding recipient

Response Example

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

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