Signaling Message Format
The IM service predefines signaling messages, which are only used by the SDK to implement its own business functions. Developers do not need to handle them.
Command Message
The IM service defines a command message with the ObjectName RC:CmdMsg. The difference between this and the command notification message (RC:CmdNtf) is that the command message is not stored and will not be displayed on the interface.
When calling the server API to send a message, you must specify the ObjectName and serialize the corresponding message content JSON object into a JSON String, then place it in the content field of the API interface. The client SDK has built-in support for this message type, allowing you to directly call the relevant methods to send it.
The operation platform can use this command message to send command information to the terminal.
The command message contains a "message content" as a JSON object, structured as follows:
{
"name":"AtPerson",
"data":"{\"sourceId\":\"9527\"}"
}
Content Structure Parameters
The content structure parameters of the command message are as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Yes | Command name, which can be user-defined. |
| data | String | Yes | Command content. |
Client Default Properties
- Not stored locally on the client
- Not counted in the unread message count of the conversation
- Remote push notification not supported by default: The IM service does not preset push notification titles and content for this message type. If you need to trigger a remote push notification when the recipient is offline, please pass in custom push notification content when sending the message.
Recall Command Message
The IM service defines a recall command message with the ObjectName RC:RcCmd.
The client SDK has built-in support for this message type. When calling the client API to recall a message, the SDK internally sends this message. It is not recommended for clients to send this message directly.
Content Structure Parameters
The content structure parameters of the recall command message are as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| MessageUId | String | Yes | Message UID, a globally unique ID generated by the server. |
| TargetId | String | Yes | Conversation ID. |
| ChannelId | String | Yes | Ultra group channel ID. |
| SentTime | String | Yes | Message sending time. |
| ConversationType | String | Yes | Conversation type. |
| isAdmin | boolean | Yes | Whether it is an admin operation. |
| isDelete | boolean | Yes | Specifies whether the mobile client should delete the original message record locally. When false, the mobile client will not delete the original message record and will replace the message content with a recall notification (gray bar notification). When true, the mobile client will delete the original message record and will not display the recall notification (gray bar notification). The web client recall message interface supports this parameter starting from SDK version 5.3.1. |
Client Default Properties
- Not stored locally on the client
- Not counted in the unread message count of the conversation
- Remote push notification supported by default:
- Push notification title: For one-to-one and system conversation messages, the push title defaults to the sender's nickname. For group and ultra group messages, the push title defaults to the group name. The default data is from the user registration or group creation information passed to the IM server. You can specify the push title when sending the message. The push title specified when sending the message has the highest priority.
- Push notification content: The default Chinese push content is a fixed string: [撤回了一条消息]. For group or ultra group messages, the sender's nickname will be prefixed, for example: Sender's nickname: [撤回了一条消息]. You can customize the push content when recalling the message.
Read Notification Message
The IM service defines a read notification message with the ObjectName RC:ReadNtf.
When calling the server API to send a message, you must specify the ObjectName and serialize the corresponding message content JSON object into a JSON String, then place it in the content field of the API interface. The client SDK has built-in support for this message type, allowing you to directly call the relevant methods to send it.
This message is used to send the status of a message that has been received. When the client receives this message, it is not counted in the unread message count and is not stored. This type of message does not have a push notification.
The read notification message contains a "message content" as a JSON object, structured as follows:
{
"lastMessageSendTime":1408706337,
"messageUId":"XXXXXX",
"type":1
}
Content Structure Parameters
The content structure parameters of the read notification message are as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| lastMessageSendTime | Int | Yes | The sending time of the last read message. |
| messageUId | String | Yes | The UId of the last read message, a unique identifier for the message. See the messageUId explanation below the table. |
| type | Int | Yes | Conversation type. Currently, this message only supports one-to-one conversations, with a type of 1. |
messageUId Explanation
- Read notification messages sent from the web client include the
messageUIdfield by default. - Read notification messages sent from Android / iOS mobile clients do not include the
messageUIdfield by default.
Client Default Properties
- Not stored locally on the client
- Not counted in the unread message count of the conversation
- Remote push notification not supported by default: The IM service does not preset push notification titles and content for this message type. If you need to trigger a remote push notification when the recipient is offline, please pass in custom push notification content when sending the message.
Group Read Receipt Request Message
The IM service defines a group read receipt request message with the ObjectName RC:RRReqMsg.
When calling the server API to send a message, you must specify the ObjectName and serialize the corresponding message content JSON object into a JSON String, then place it in the content field of the API interface. The client SDK has built-in support for this message type, allowing you to directly call the relevant methods to send it.
When sending a message in a group and needing to obtain the read receipt for this message, you can send a read request message to the group. When the user receives this message and reads the specified message, they will send a read status message to the message sender.
The group read receipt request message contains a "message content" as a JSON object, structured as follows:
{
"messageUId":"596E-P5PG-4FS2-7OJK"
}
Content Structure Parameters
The content structure parameters of the group read receipt request message are as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| messageUId | String | Yes | The message ID for which the read receipt is requested. |
Client Default Properties
- Not stored locally on the client
- Not counted in the unread message count of the conversation
- Remote push notification not supported by default: The IM service does not preset push notification titles and content for this message type. If you need to trigger a remote push notification when the recipient is offline, please pass in custom push notification content when sending the message.
Group Read Receipt Response Message
The IM service defines a group read receipt response message with the ObjectName RC:RRRspMsg.
When calling the server API to send a message, you must specify the ObjectName and serialize the corresponding message content JSON object into a JSON String, then place it in the content field of the API interface. The client SDK has built-in support for this message type, allowing you to directly call the relevant methods to send it.
This message is used to send the read status of a message in a group. When the client receives this message, it is not counted in the unread message count and is not stored.
The group read receipt response message contains a "message content" as a JSON object, structured as follows:
{
"receiptMessageDic":{"wX7zFv8dR":["BJN3-LSG0-7MUC-OR7A"]}
}
Content Structure Parameters
The content structure parameters of the group read receipt response message are as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| receiptMessageDic | String | Yes | A dictionary of messages requiring receipts. The key is the sender's userId, and the value is an array of MessageUIds of the messages requiring receipts from that user. |
Client Default Properties
- Not stored locally on the client
- Not counted in the unread message count of the conversation
- Remote push notification not supported by default: The IM service does not preset push notification titles and content for this message type. If you need to trigger a remote push notification when the recipient is offline, please pass in custom push notification content when sending the message.
Multi-Endpoint Read Status Synchronization Message
The IM service defines a multi-endpoint read status synchronization message with the ObjectName RC:SRSMsg.
When calling the server API to send a message, you must specify the ObjectName and serialize the corresponding message content JSON object into a JSON String, then place it in the content field of the API interface. The client SDK has built-in support for this message type, allowing you to directly call the relevant methods to send it.
When a user has multiple endpoints, this message is used to synchronize the read status of a message from one endpoint to another.
The multi-endpoint read status synchronization message contains a "message content" as a JSON object, structured as follows:
{
"lastMessageSendTime":1610941689734
}
Content Structure Parameters
The content structure parameters of the multi-endpoint read status synchronization message are as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| lastMessageSendTime | Int | Yes | The sending time of the last read message. |
Client Default Properties
- Not stored locally on the client
- Not counted in the unread message count of the conversation
- Remote push notification not supported by default: The IM service does not preset push notification titles and content for this message type. If you need to trigger a remote push notification when the recipient is offline, please pass in custom push notification content when sending the message.
Chatroom Attribute Notification Message
The IM service defines a chatroom attribute notification message with the ObjectName RC:chrmKVNotiMsg.
When calling the server API to send a message, you must specify the ObjectName and serialize the corresponding message content JSON object into a JSON String, then place it in the content field of the API interface. The client SDK has built-in support for this message type, allowing you to directly call the relevant methods to send it.
The chatroom attribute notification message contains a "message content" as a JSON object, structured as follows:
{
"type":1,
"key":"name",
"value":"主播",
"extra":""
}
Content Structure Parameters
The content structure parameters of the chatroom attribute notification message are as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| type | Int | Yes | The type of notification sent after an attribute operation in the chatroom, where 1 is for setting attribute content and 2 is for deleting attribute content. |
| key | String | Yes | The attribute name in the chatroom, with a maximum of 128 characters. |
| value | String | Yes | The content corresponding to the attribute, with a maximum of 4096 characters. |
| extra | String | No | Additional information carried in the message, corresponding to the notificationExtra value in the set attribute interface. |
Client Default Properties
- Stored locally on the client
- Not counted in the unread message count of the conversation
- Remote push notification not supported by default: The IM service does not preset push notification titles and content for this message type. If you need to trigger a remote push notification when the recipient is offline, please pass in custom push notification content when sending the message.
Message Extension Function Message
Message Extension Function Message is only used in ultra group business. The client cannot receive this type of message.
The message extension function message has the ObjectName RC:MsgExMsg.
In ultra group message business, when setting or deleting message extension information, you can receive message extension function messages through message callbacks or post-messaging callback. The client cannot receive this type of message.
When setting message extensions, the message structure is as follows:
{
"clear":0,"put":{"123":"示例文本","2":"222","3":"示例文本"}
}
When deleting message extensions, the message structure is as follows:
{
"clear":0,"del":{"123":"示例文本","2":"222","3":"示例文本"}
}
Structure explanation:
| Field | Description |
|---|---|
| clear | Whether to delete all attribute values, where 1 means delete all and 0 means do not delete all |
| del | Array of attribute Key/Value pairs to delete |
| put | Array of attribute Key/Value pairs to set |