Message Overview

Basic Message Structure

Property Name	Type	Description
conversationType	RCIMIWConversationType	Conversation type
messageType	RCIMIWMessageType	Message type
targetId	string	Conversation ID
channelId	string	Business identifier of the conversation, limited to 20 characters
messageId	number	Unique ID of the message stored in the local database. When sending a new message, this ID should not be specified, otherwise the message will fail to be stored. When resending a failed message, you can use the ID of the previously failed message. Ensure that the message instance from the last failed send is used.
messageUId	string	Server message unique ID (globally unique under the same App Key)
offLine	boolean	Whether it is an offline message. This is only valid in the callback method for receiving messages. If the message is an offline message, the value is YES; otherwise, it is NO.
groupReadReceiptInfo	RCIMIWGroupReadReceiptInfo	Group read receipt status
receivedTime	number	Message received time (Unix timestamp, milliseconds)
sentTime	number	Message sent time (Unix timestamp, milliseconds)
receivedStatus	RCIMIWReceivedStatus	Message received status
sentStatus	RCIMIWSentStatus	Message sent status
senderUserId	string	Sender ID
direction	RCIMIWMessageDirection	Message direction
userInfo	RCIMIWUserInfo	User information carried by the message
mentionedInfo	RCIMIWMentionedInfo	Mention information in the message
pushOptions	RCIMIWMessagePushOptions	Message push configuration
extra	string	Additional fields of the message
expansion	Map<string, string>	List of message extensions. This property is determined when the message is sent and cannot be modified afterward. Extensions are only supported in one-to-one and group chats. Other conversation types cannot set extensions. The default message extension key length cannot exceed 32, and the value length cannot exceed 4096. The maximum number of extensions that can be set at once is 20, and the total number of message extensions cannot exceed 300.

Message Types

The message types (RCIMIWMessageType) enumeration in IMLib provides predefined text, voice, image, and other message types. It also supports custom messages through RCIMIWMessageType.CUSTOM.

By default, all types of messages are stored locally on the client and count toward unread messages. The following types are exceptions:

• Recall message type (RCIMIWMessageType.RECALL): Stored locally on the client but does not count toward unread messages.
• Command message type (RCIMIWMessageType.COMMAND): Not stored locally on the client and does not count toward unread messages.
• Command notification message type (RCIMIWMessageType.COMMAND_NOTIFICATION): Stored locally on the client but does not count toward unread messages.
• Custom message type (RCIMIWMessageType.CUSTOM): Storage policy is controlled by the app via RCIMIWCustomMessagePolicy.

Text Message

Type: RCIMIWMessageType.TEXT

Exclusive accessible properties:

Property Name	Type	Description
text	string	Text content

Constructing a Text Message

engine.createTextMessage(type, targetId, channelId, text)
.then((message: RCIMIWTextMessage) => {});

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
text	string	Text content

Voice Message

Type: RCIMIWMessageType.VOICE

Exclusive accessible properties:

Property Name	Type	Description
duration	number	Voice duration in seconds

Constructing a Voice Message

engine.createVoiceMessage(
  type,
  targetId,
  channelId,
  path,
  duration
)
.then((message: RCIMIWVoiceMessage) => {});

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
path	string	Local path of the voice message, must be a valid path
duration	number	Duration of the voice message

Image Message

Type: RCIMIWMessageType.IMAGE

Exclusive accessible properties:

Property Name	Type	Description
thumbnailBase64String	string	Thumbnail data of the image
original	boolean	Whether it is the original image

Constructing an Image Message

engine.createImageMessage(conversationType, targetId, channelId, path)
.then((message: RCIMIWImageMessage) => {})

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
path	string	Local path of the image message, must be a valid path

File Message

Type: RCIMIWMessageType.FILE

Exclusive accessible properties:

Property Name	Type	Description
name	string	File name
fileType	string	File type
size	number	File size in bytes

Constructing a File Message

engine.createFileMessage(conversationType, targetId, channelId, path)
.then((message: RCIMIWFileMessage) => {})

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
path	string	Local path of the file message, must be a valid path

Short Video Message

Type: RCIMIWMessageType.SIGHT

Exclusive accessible properties:

Property Name	Type	Description
duration	number	Video duration
size	number	Video size
name	string	Video name
thumbnailBase64String	string	Thumbnail data

Constructing a Short Video Message

engine.createSightMessage(conversationType, targetId, channelId, path, duration)
.then((message: RCIMIWSightMessage) => {})

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
path	string	Local path of the short video message, must be a valid path
duration	number	Duration of the short video message

GIF Message

Type: RCIMIWMessageType.GIF

Exclusive accessible properties:

Property Name	Type	Description
dataSize	number	GIF size in bytes
width	number	GIF width
height	number	GIF height

Constructing a GIF Message

engine.createGIFMessage(conversationType, targetId, channelId, path)
.then((message: RCIMIWGIFMessage) => {})

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
path	string	Local path of the GIF message

Recall Message

Recall messages cannot be actively constructed and sent. To recall a message, please call the recall message interface.

Type: RCIMIWMessageType.RECALL

Exclusive accessible properties:

Property Name	Type	Description
admin	boolean	Whether it is an admin operation
deleted	boolean	Whether it is deleted
recallTime	number	Sent time of the original message being recalled (milliseconds)
recallActionTime	number	Time of the recall action (milliseconds)
originalMessage	RCIMIWMessage	The original message being recalled

Reference Message

Type: RCIMIWMessageType.REFERENCE

Exclusive accessible properties:

Property Name	Type	Description
text	string	Reference text
referenceMessage	RCIMIWMessage	The referenced message

Constructing a Reference Message

engine.createReferenceMessage(conversationType, targetId, channelId, path, text)
.then((message: RCIMIWReferenceMessage) => {})

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
referenceMessage	RCIMIWMessage	The referenced message
text	string	Reference text content

Location Message

Type: RCIMIWMessageType.LOCATION

Exclusive accessible properties:

Property Name	Type	Description
longitude	number	Longitude information
latitude	number	Latitude information
poiName	string	POI information
thumbnailPath	string	Thumbnail path

Constructing a Location Message

engine.createLocationMessage(conversationType, targetId, channelId, longitude, latitude, poiName, thumbnailPath)
.then((message: RCIMIWLocationMessage) => {})

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
longitude	number	Longitude
latitude	number	Latitude
poiName	string	POI information
thumbnailPath	string	Local path of the thumbnail, must be a valid path

Command Message

Type: RCIMIWMessageType.COMMAND

Exclusive accessible properties:

Property Name	Type	Description
name	string	Command name
data	string	Command extension data, which can be any string, such as JSON data defined by you.

Command Notification Message

Type: RCIMIWMessageType.COMMAND_NOTIFICATION

Exclusive accessible properties:

Property Name	Type	Description
name	string	Command notification name
data	string	Command notification message extension data, which can be any string, such as JSON data defined by you.

Custom Message

Type: RCIMIWMessageType.CUSTOM

Exclusive accessible properties:

Property Name	Type	Description
identifier	string	Custom message identifier
policy	RCIMIWCustomMessagePolicy	Custom message storage policy
fields	Map<string, string>	Key-value pairs of the custom message

Constructing a Custom Message

engine.createCustomMessage(
  type,
  targetId,
  channelId,
  policy,
  messageIdentifier,
  fields
)
.then((message: RCIMIWCustomMessage) => {})

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	string	Conversation ID
channelId	string	Channel ID, only supported in ultra groups. For other conversation types, pass null.
policy	RCIMIWCustomMessagePolicy	Message storage policy
messageIdentifier	string	Message identifier, must be unique
fields	Map<string, string>	Key-value pairs of the message content

Invalid Type

When an unrecognized message is received, it will become an invalid type message. This type of message cannot be actively constructed and sent.

Type: RCIMIWMessageType.UNKNOWN

Exclusive accessible properties:

Property Name	Type	Description
rawData	string	Message data
objectName	string	Message identifier