Starter Deal! First 3 month from only  $9.9 /month!
Starter Deal! First 3 month from only  $9.9 /month!
Grab It Now 
Chat
  • Web
    • TUIKit
      • Overview
      • Installaton
        • TUIKit
          • Vue
          • React
        • TUIChat Only
          • Vue
      • Features
        • Reactions
        • Read Receipt
        • Typing Status
        • User Online Status
      • Themes
        • Setting UI Styles
          • Web
          • Mobile
      • Customization
        • Customize Messages
      • Localization
    • SDK
      • Install Chat SDK
      • Initialize Chat SDK
      • Login and Logout
      • Client APIs
      • Message
        • Overview
        • Send a Message
        • Receive a Message
        • Historical Message
        • Forward Messages
        • Modify a Message
        • Delete Messages
        • Clear History Message
        • Recall a Message
        • Send an Online Message
        • Message Read Receipt
        • Query Messages
        • Targeted Group Message
        • Do not Notify
        • Key-Value Extensions
        • Translation
      • Conversation
        • Overview
        • Conversation List
        • Get Conversations
        • Unread Count
        • Pin Conversations
        • Delete Conversations
        • Mark
        • Conversation Group
      • Group
        • Overview
        • Group Management
        • Group Profile
        • Group Member Management
        • Group Member Profile
        • Custom Group Attribute
        • Group Counter
      • Community Topic
        • Community Management
      • User Profile and Relationship Chain
        • User Profile
        • User Status
        • Friend Management
        • Friend List
        • Block List
  • Android
    • Run Demo
    • UIKit
      • Overview
      • Getting Started
      • Installation
        • TUIKit
        • TUIChat Only
      • Features
        • Reactions
        • Read Receipt
        • User Online Status
        • Search Messages
      • Customization
        • Customize Messages
        • Customize Emojis and Stickers
      • Localization
    • SDK
      • Install Chat SDK
      • Initialize Chat SDK
      • Login and Logout
      • Message
        • Overview
        • Send a Message
        • Receive a Message
        • Retrieve Messages
        • Forward Messages
        • Modify a Message
        • Insert a Message
        • Delete Messages
        • Clear History Messages
        • Recall a Message
        • Send an Online Message
        • Message Read Receipt
        • Query Messages
        • Metions
        • Targeted Group Message
        • Do not Notify
        • Key-Value Extensions
        • Reactions
        • Translation
        • Pin Messages
      • Conversation
        • Overview
        • Conversation List
        • Get Conversations
        • Unread Count
        • Pin Conversations
        • Delete Conversations
        • Draft
        • Mark
        • Conversation Group
      • Group
        • Overview
        • Manage Group
        • Profile
        • Manage Members
        • Member Profile
        • Attribute
        • Counter
      • Community and Topic
        • Manage Community
        • Permission Group
      • User
        • User Profile
        • User Status
        • Manage Friends
        • Friend Group
        • Block Lists
      • Local Search
        • Search Messages
        • Search Friends
        • Search Groups
        • Search Group Members
      • Signaling
      • API Reference
        • Java
  • iOS and macOS
    • Run Demo
    • UIKit
      • Overview
      • Getting Started
      • Installation
        • TUIKit
        • TUIChat Only
      • Features
        • Reactions
        • Read Receipt
        • User Online Status
        • Search Messages
      • Customization
        • Customize Messages
        • Customize Emojis and Stickers
      • Localization
    • SDK
      • Installation
        • iOS
        • macOS
      • Initialize Chat SDK
      • Login and Logout
      • Message
        • Overview
        • Send a Message
        • Receive a Message
        • Retrieve Messages
        • Forward Messages
        • Modify a Message
        • Insert a Message
        • Delete Messages
        • Clear History Messages
        • Recall a Message
        • Send an Online Message
        • Message Read Receipt
        • Query Messages
        • Metions
        • Targeted Group Messages
        • Do not Notify
        • Key-Value Extensions
        • Reactions
        • Translation
        • Pin Messages
      • Conversation
        • Overview
        • Conversation List
        • Get Conversations
        • Unread Count
        • Pin Conversations
        • Delete Conversations
        • Draft
        • Mark
        • Conversation Group
      • Group
        • Overview
        • Manage Group
        • Profile
        • Manage Members
        • Member Profile
        • Attribute
        • Counter
      • Community and Topic
        • Manage Community
        • Permission Group
      • User
        • User Profile
        • User Status
        • Manage Friends
        • Friend Group
        • Block Lists
      • Local Search
        • Search Messages
        • Search Friends
        • Search Groups
        • Search Group Members
      • Signaling
      • API Reference
        • Swift
        • Objective-C
  • Windows
    • SDK
      • Install Chat SDK
      • Initialize Chat SDK
      • Login and Logout
      • Message
        • Overview
        • Send a Message
        • Receive a Message
        • Retrieve Messages
        • Forward Messages
        • Modify a Message
        • Insert a Message
        • Delete Messages
        • Clear History Messages
        • Recall a Message
        • Send an Online Message
        • Message Read Receipt
        • Query Messages
        • Metions
        • Targeted Group Messages
        • Do not Notify
        • Key-Value Extensions
        • Reactions
        • Translation
        • Pin Messages
      • Conversation
        • Overview
        • Conversation List
        • Get Conversations
        • Unread Count
        • Pin Conversations
        • Delete Conversations
        • Draft
        • Mark
        • Conversation Group
      • Group
        • Overview
        • Manage Group
        • Profile
        • Manage Members
        • Member Profile
        • Attribute
        • Counter
      • Community and Topic
        • Manage Community
        • Permission Group
      • User
        • User Profile
        • User Status
        • Manage Friends
        • Friend Group
        • Block Lists
      • Local Search
        • Search Messages
        • Search Friends
        • Search Groups
        • Search Group Members
      • Signaling
      • API Reference
        • C++
        • C
  • Flutter
    • Run Demo
    • UIKIT
      • Overview
      • Installation
        • integrated
      • Features
        • Local Search
        • Offline Push
        • Online Status
        • Typing Status
        • Message Read Receipt
        • Message Reactions
        • Internationalization
        • Adding Custom Messages
        • Emoji & Stickers
      • Customization
        • Modifying UI Themes
        • Setting UI Styles
    • SDK
      • Install Chat SDK
        • Install
      • Initialize Chat SDK
        • Initialize
      • Login And Logout
        • Login and Logout
      • Message
        • Message Overview
        • Sending Message
        • Receiving Message
        • Historical Message
        • Forwarding Message
        • Modifying Message
        • Message Inserting
        • Deleting Message
        • Clearing Messages
        • Recalling Message
        • Online Message
        • Read Receipt
        • Querying Message
        • Group @ Message
        • Targeted Group Message
        • Notification Muting
        • Message Extension
      • Conversation
        • Conversation Overview
        • Conversation List
        • Getting Conversation
        • Conversation Unread Count
        • Pinning Conversation to the Top
        • Deleting Conversation
        • Conversation Draft
        • Conversation Group
      • Group
        • Group Overview
        • Group Management
        • Group Profile
        • Group Member Management
        • Group Member Profile
        • Custom Group Attribute
      • User
        • User Profile
        • Friend Management
        • Friend List
        • Blocklist
      • Offline Push
        • Offline Push
      • Signaling
        • Signaling Management
      • Local Search
        • Searching for Message
        • Searching for Friend
        • Searching Group
        • Searching for Group Member
      • API Reference
        • Client APIs
  • React Native
    • Run Demo
    • SDK
      • SDK Integration
      • Initialization
      • Login and Logout
      • Message
        • Message Overview
        • Sending Message
        • Receiving Message
        • Historical Message
        • Forwarding Message
        • Modifying Message
        • Message Inserting
        • Deleting Message
        • Clearing Messages
        • Recalling Message
        • Online Message
        • Read Receipt
        • Querying Message
        • Group @ Message
        • Targeted Group Message
        • Notification Muting
        • Message Extension
      • Group
        • Overview
        • Group Management
        • Group Profile
        • Group Member Management
        • Group Member Profile
        • Custom Group Attribute
        • Community Management
      • User
        • User Profile
        • Friend Management
        • Friend List
        • Blocklist
      • Offline Push
        • Offline Push
      • Local Search
        • Searching for Message
        • Searching for Friend
        • Searching Group
        • Searching for Group Member
      • Signaling
        • Signaling Management
  • Unity(Game Solution)
    • Run Demo
    • SDK
      • SDK Integration
      • Initialization
      • Login and Logout
      • Message
        • Message Overview
        • Sending Message
        • Receiving Message
        • Historical Message
        • Forwarding Message
        • Modifying Message
        • Deleting Message
        • Clearing Messages
        • Recalling Message
        • Online Message
        • Read Receipt
        • Querying Message
        • Group @ Message
        • Targeted Group Message
        • Notification Muting
        • Message Extension
      • Conversation
        • Conversation Overview
        • Conversation List
        • Getting Conversation
        • Conversation Unread Count
        • Pinning Conversation to the Top
        • Deleting Conversation
        • Conversation Draft
        • Conversation Mark
        • Conversation Group
      • Group
        • Group Overview
        • Group Management
        • Group Profile
        • Group Member Management
        • Group Member Profile
        • Custom Group Attribute
        • Group Counter
      • User
        • User Profile
        • User Status
        • Friend Management
        • Friend List
        • Blocklist
  • Unreal Engine(Game Solution)
    • SDK
      • SDK Integration
  • Free Demos
  • Server APIs
    • Generating UserSig
    • RESTful APIs
      • RESTful API Overview
      • RESTful API List
      • Message Related
        • Send Message
          • Sending One-to-One Messages to One User
          • Sending One-to-One Messages to Multiple Users
          • Sending Ordinary Messages in a Group
          • Sending System Messages in a Group
          • Broadcast Message of Audio-Video Group
          • Importing One-to-One Messages
          • Importing Group Messages
        • Historical Message
          • Modifying Historical One-to-one Messages
          • Modifying Historical Group Messages
          • Pulling Historical One-to-one Messages
          • Pulling Historical Group Messages
        • Delete Message
          • Deleting Messages Sent by a Specified User
        • Withdraw Message
          • Recalling One-to-One Messages
          • Recalling Group Messages
        • Read Receipt
          • Marking One-to-One Messages as Read
          • Pulling Group Message Read Receipt Details
          • Pulling Read Receipts for Group Messages
        • Message Extension
          • Pulling the Message Extension of a One-to-One Message
          • Configuring Message Extension for a One-to-One Message
          • Pulling Message Extension of a Group Message
          • Configuring Message Extension for a Group Message
        • Pushing to All Users
          • API for Pushing to All Users
          • Pushing to All Users
          • Setting Application Attribute Names
          • Getting Application Attribute Names
          • Getting User Attributes
          • Setting User Attributes
          • Deleting User Attributes
          • Getting User Tags
          • Adding User Tags
          • Deleting User Tags
          • Deleting All Tags of a User
      • Session Related
        • Conversation List
          • Pulling a conversation list
        • Session Unread Count
          • Setting the Unread Message Count of a Member
          • Querying Unread One-to-One Message Count
        • Delete Session
          • Deleting a conversation
        • Session Grouping Tag
          • Creating Conversation Group Data
          • Updating Conversation Group Data
          • Deleting Conversation Group Data
          • Creating or Updating Conversation Mark Data
          • Searching for Conversation Group Marks
          • Pulling Conversation Group Mark Data
      • Group Related
        • Group Management
          • Getting All Groups in an App
          • Creating a Group
          • Disbanding a Group
          • Getting the Groups a User Has Joined
        • Group Information
          • Getting Group Profiles
          • Modifying the Profile of a Group
          • Importing a Group Profile
        • Group Member Management
          • Adding Group Members
          • Deleting Group Members
          • Banning Group Members
          • Unbanning Group Members
          • Bulk Muting and Unmuting
          • Getting the List of Muted Group Members
          • Changing Group Owner
          • Querying the Roles of Users in a Group
          • Importing Group Members
        • Group Member Information
          • Getting Group Member Profiles
          • Modifying the Profile of a Group Member
        • Group Custom Attributes
          • Getting Group Custom Attributes
          • Modifying Group Custom Attributes
          • Clearing Group Custom Attributes
          • Resetting Group Custom Attributes
          • Deleting Group Custom Attributes
        • Live Group Management
          • Getting the Number of Online Users in an Audio-Video Group
          • Getting the List of Online Members in Audio-Video Group
          • Setting Audio-Video Group Member Marks
          • Getting the List of Banned Group Members.
        • Community Management
          • Creating Topic
          • Deleting Topic
          • Getting Topic Profile
          • Modifying Topic Profile
          • Importing Topic Profiles
        • Group Counter
          • Getting Group Counters
          • Updating Group Counters
          • Deleting Group Counters
      • User Management
        • Account Management
          • Importing a Single Account
          • Importing Multiple Accounts
          • Deleting Accounts
          • Querying Accounts
        • User Information
          • Setting Profiles
          • Pulling Profiles
        • User Status
          • Invalidating Account Login States
          • Querying Account Online Status
        • Friend Management
          • Adding Friends
          • Importing Friends
          • Updating Friends
          • Deleting Friends
          • Deleting All Friends
          • Verifying Friends
          • Pulling Friends
          • Pulling Specified Friends
        • Friend Lists
          • Adding Lists
          • Deleting Lists
          • Pulling Lists
        • Blocklist
          • Blocklisting Users
          • Unblocklisting Users
          • Pulling a Blacklist
          • Verifying Users on a Blocklist
      • Global Mute Management
        • Setting Global Mute
        • Querying Global Mute
      • Operations Management
        • Pulling Operations Data
        • Downloading Recent Messages
        • Getting Server IP Addresses
      • Chatbots
        • Pulling Chatbot Accounts
        • Creating Chatbot Accounts
        • Deleting Chatbot Accounts
    • Webhooks
      • Webhook Overview
      • Webhook Command List
      • Operations Management Callbacks
        • API Overclocking Alarm Callbacks
      • Online Status Webhooks
        • Status Change Webhooks
      • Relationship Chain Webhooks
        • After a Profile Is Updated
        • Before a Friend Is Added
        • Before a Friend Request Is Responded
        • After a Friend Is Added
        • After a Friend Is Deleted
        • After a User Is Added to Blocklist
        • After a User Is Removed from Blocklist
      • One-to-One Message Webhooks
        • Before a One-to-One Message Is Sent
        • After a One-to-One Message Is Sent
        • After a One-to-One message Is Marked as Read
        • After A One-to-One Message Is Recalled
      • Group Webhooks
        • Before a Group Is Created
        • After a Group Is Created
        • Before Applying to Join a Group
        • Before Inviting a User to a Group
        • After a User Joins a Group
        • After a User Leaves a Group
        • Before Group Message Is Sent
        • After a Group Message Is Sent
        • After a Group Is Full
        • After a Group Is Disbanded
        • After Group Profile Is Modified
        • Callback After Recalling Group Messages
        • Webhook for Online and Offline Status of Audio-Video Group Members
        • Webhook for Exceptions When Group Messages Are Sent
        • Before a Topic Is Created
        • After a Topic Is Created
        • After a Topic Is Deleted
        • Topic Profile Change Webhook
        • Callback After Group Member Profile Changed
        • Callback After Group Attribute Changed
        • Callback After Read Receipt
        • Callback After the Group Owner Changed
      • Webhook Mutual Authentication Configuration Guide
        • Apache Mutual Authentication Configuration
        • Nginx Mutual Authentication Configuration
      • Chatbot webhooks
        • Chatbot Passthrough Message Callback
  • Console Guide
    • Creating and Upgrading an Application
    • Basic Configuration
    • Feature Configuration
    • Account Management
    • Group Management
    • Webhook Configuration
  • Product Introduction
    • Message Management
      • One-to-One Message
      • Message Storage
      • Offline Push
      • Group Message
      • Message Formats
    • Account System
      • Login Authentication
      • Online Status Management
    • Group Related
      • Group System
      • Group Management
    • User Profile and Relationship Chain
      • Profile Management
      • Relationship Chain Management
  • Purchase Guide
    • Billing Overview
    • Pricing
  • Error Codes
Chat

Receiving Message

Overview

All types of messages (text, custom, and rich media messages) are listened for and received with the addAdvancedMsgListener API, with the callbacks defined in the protocol of V2TimAdvancedMsgListener.

Setting Message Listeners

Advanced message listener

Adding a listener

The receiver calls the addAdvancedMsgListener API (details) to add the advanced message listener. It is recommended to call the API early (such as after the chat panel is initialized) to ensure timely message receiving in the application.
Sample code:
// Create a message listener
V2TimAdvancedMsgListener listener = V2TimAdvancedMsgListener(
onRecvC2CReadReceipt: (List<V2TimMessageReceipt> receiptList) {
// Callback after marking a one-to-one message as read
},
onRecvMessageModified: (V2TimMessage message) {
// `msg` is the modified message object
},
onRecvMessageReadReceipts: (List<V2TimMessageReceipt> receiptList) {
// Callback after marking a group message as read
receiptList.forEach((element) {
element.groupID; // Group ID
element.msgID; // Message ID
element.readCount;// Latest group message read count
element.unreadCount;// Latest group message unread count
element.userID; // ID of the other party of the one-to-one message
});
},
onRecvMessageRevoked: (String messageid) {
// Process the recalled messages among locally maintained messages
},
onRecvNewMessage: (V2TimMessage message) async {
// Process a text message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_TEXT) {
message.textElem?.text;
}
// Use a custom message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_CUSTOM) {
message.customElem?.data;
message.customElem?.desc;
message.customElem?.extension;
}
// Use an image message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_IMAGE) {
message.imageElem
?.path; // Image upload path. This field applies only to the message sender who can use it to display the image on the screen in advance to optimize the experience
message.imageElem?.imageList?.forEach((element) {
// Traverse large images, original images, and thumbnails
// Parse image attributes
element?.height;
element?.localUrl;
element?.size;
element?.type; // Large image, original image, or thumbnail
element?.url;
element?.uuid;
element?.width;
});
}
// Process a video message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_VIDEO) {
// Parse the video message attributes such as thumbnail, playback address, width and height, and size
message.videoElem?.UUID;
message.videoElem?.duration;
message.videoElem?.localSnapshotUrl;
message.videoElem?.localVideoUrl;
message.videoElem?.snapshotHeight;
message.videoElem?.snapshotPath;
// ...
}
// Process an audio message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_SOUND) {
// Parse the playback address, local address, size, and duration of the audio message.
message.soundElem?.UUID;
message.soundElem?.dataSize;
message.soundElem?.duration;
message.soundElem?.localUrl;
message.soundElem?.url;
// ...
}
// Process a file message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_FILE) {
// Parse the filename, size, URL and other info of the file message
message.fileElem?.UUID;
message.fileElem?.fileName;
message.fileElem?.fileSize;
message.fileElem?.localUrl;
message.fileElem?.path;
message.fileElem?.url;
}
// Process a location message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_LOCATION) {
// Parse the geographical location information such as latitude, longitude, and description
message.locationElem?.desc;
message.locationElem?.latitude;
message.locationElem?.longitude;
}
// Process an emoji message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_FACE) {
message.faceElem?.data;
message.faceElem?.index;
}
// Process a group tip text message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_GROUP_TIPS) {
message.groupTipsElem?.groupID; // Group
message.groupTipsElem?.type; // Group tip type
message.groupTipsElem?.opMember; // Operator profile
message.groupTipsElem?.memberList; // User profile being operated
message.groupTipsElem?.groupChangeInfoList; // Group information change details
message.groupTipsElem?.memberChangeInfoList; // Group member change information
message.groupTipsElem?.memberCount; // Number of current online group members
}
// Process a combined message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_MERGER) {
message.mergerElem?.abstractList;
message.mergerElem?.isLayersOverLimit;
message.mergerElem?.title;
V2TimValueCallback<List<V2TimMessage>> download =
await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.downloadMergerMessage(
msgID: message.msgID!,
);
if (download.code == 0) {
List<V2TimMessage>? messageList = download.data;
}
}
if (message.textElem?.nextElem != null) {
// Get the next element object through the `nextElem` method of the first element object. If the next object exists, an element object instance is returned; otherwise, `null` is returned.
}
},
onSendMessageProgress: (V2TimMessage message, int progress) {
// File upload progress callback
},
);
// Add an event listener for advanced messages
TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.addAdvancedMsgListener(listener: listener);

Removing a listener

To stop receiving messages, the receiver calls removeAdvancedMsgListener API (details) to remove the advanced message listener.
Sample code:
// Create a listener
V2TimAdvancedMsgListener listener = V2TimAdvancedMsgListener(
onRecvC2CReadReceipt: (List<V2TimMessageReceipt> receiptList) {},
onRecvMessageModified: (V2TimMessage message) {},
onRecvMessageReadReceipts: (List<V2TimMessageReceipt> receiptList) {},
onRecvMessageRevoked: (String messageid) {},
onRecvNewMessage: (V2TimMessage message) {},
onSendMessageProgress: (V2TimMessage message, int progress) {},
);
// Register the listener
TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.addAdvancedMsgListener(listener: listener);
// Remove the listener
TencentImSDKPlugin.v2TIMManager.getMessageManager().removeAdvancedMsgListener(listener: listener);

Receiving Text Messages

The receiver can receive a one-to-one or group text message with the advanced message listener in the following steps:
1. Call addAdvancedMsgListener to set the event listener.
2. Listen for the onRecvNewMessage callback (details) that contains the custom message.
3. To stop receiving messages, call removeAdvancedMsgListener to remove the listener. This step is optional and can be performed as needed.
Sample code:
V2TimAdvancedMsgListener listener = V2TimAdvancedMsgListener(
onRecvC2CReadReceipt: (List<V2TimMessageReceipt> receiptList) {},
onRecvMessageModified: (V2TimMessage message) {},
onRecvMessageReadReceipts: (List<V2TimMessageReceipt> receiptList) {},
onRecvMessageRevoked: (String messageid) {},
onRecvNewMessage: (V2TimMessage message) {
// Process a text message
if(message.elemType == MessageElemType.V2TIM_ELEM_TYPE_TEXT){
String text = message.textElem.text;
}
},
onSendMessageProgress: (V2TimMessage message, int progress) {},
);
TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.addAdvancedMsgListener(listener: listener);

Receiving Custom Messages

The receiver can receive a custom one-to-one or group message with the advanced message listener in the following steps:
1. Call addAdvancedMsgListener to set the event listener.
2. Listen for the onRecvNewMessage callback (details) that contains the custom message.
3. To stop receiving messages, call removeAdvancedMsgListener to remove the listener. This step is optional and can be performed as needed.
Sample code:
V2TimAdvancedMsgListener listener = V2TimAdvancedMsgListener(
onRecvC2CReadReceipt: (List<V2TimMessageReceipt> receiptList) {},
onRecvMessageModified: (V2TimMessage message) {},
onRecvMessageReadReceipts: (List<V2TimMessageReceipt> receiptList) {},
onRecvMessageRevoked: (String messageid) {},
onRecvNewMessage: (V2TimMessage message) {
// Use a custom message
if(message.elemType == MessageElemType.V2TIM_ELEM_TYPE_CUSTOM){
String data = message.customElem.data;
String desc = message.customElem.desc;
String ext = message.customElem.extension;
}
},
onSendMessageProgress: (V2TimMessage message, int progress) {},
);
TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.addAdvancedMsgListener(listener: listener);

Receiving Rich Media Messages

The receiver can receive a rich media message only with the advanced message listener in the following steps:
1. Call the addAdvancedMsgListener API to set the advanced message listener.
2. Listen for the onRecvNewMessage callback (details) to get the V2TimMessage message.
3. Parse the elemType attribute in the V2TIMMessage message, and then parse the message again according to the type to get the specific content of the elements in the message.
4. To stop receiving messages, call removeAdvancedMsgListener to remove the listener. This step is optional and can be performed as needed.

Image message

The image in an image message can be in three formats: original, large, and thumbnail. The latter two are automatically generated by the SDK during message sending and can be ignored. Large (large image): A large image is an image obtained after the original image is proportionally compressed. After the compression, the height or width (whichever is shorter) is equal to 720 pixels. Thumb (thumbnail): A thumbnail is an image obtained after the original image is proportionally compressed. After the compression, the height or width (whichever is shorter) is equal to 198 pixels.
In the SDK for Flutter 5.0.4 or later, multimedia message online URLs (url) will not be returned when users get the message list. They need to be obtained by calling the getMessageOnlineUrl API (details). In the SDK for Flutter SDK 5.0.4 or later, multimedia message local URLs (localurl) will no longer be returned by default. They will be returned only after you download messages successfully by calling the downloadMessage API (details).
The following sample code demonstrates how to parse the image content from V2TimMessage:
V2TimAdvancedMsgListener listener = V2TimAdvancedMsgListener(
onRecvC2CReadReceipt: (List<V2TimMessageReceipt> receiptList) {},
onRecvMessageModified: (V2TimMessage message) {},
onRecvMessageReadReceipts: (List<V2TimMessageReceipt> receiptList) {},
onRecvMessageRevoked: (String messageid) {},
onRecvNewMessage: (V2TimMessage message) async {
// Use an image message
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_IMAGE) {
String path = message
.imageElem.path; // Image upload path. This field applies only to the message sender who can use it to display the image on the screen in advance to optimize the experience
for (var item in message.imageElem.imageList) { // Traverse large images, original images, and thumbnails
// Parse image attributes
int height = item.height;
String localUrl = item.localUrl;
int size = item.size;
int type = item.type; // Large image, thumbnail, or original image
String url = item.url;
String uuid = item.uuid;
int width = item.width;
}
}
// Get the multimedia message URL
V2TimValueCallback<V2TimMessageOnlineUrl> getMessageOnlineUrlRes =
await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.getMessageOnlineUrl(
msgID: '', // Message ID
);
if (getMessageOnlineUrlRes.code == 0) {
// Obtained successfully
}

// Download a multimedia message
V2TimCallback downloadMessageRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.downloadMessage(
msgID: '', // Message ID
messageType: 3, // Message type
imageType: 0, // Image type. This field is valid only for image messages.
isSnapshot: false // Whether it is a video thumbnail. This field is valid only for video messages.
);
if (downloadMessageRes.code == 0) {
// Download successful
}
},
onSendMessageProgress: (V2TimMessage message, int progress) {},
);
TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.addAdvancedMsgListener(listener: listener);

Video message

After a video message is received, a video preview is displayed on the chat page, and the video is played back after the user clicks the message.
The SDK for Flutter will download video messages when free, which can be directly used by you. Local videos and video thumbnails will be cleared when the application is uninstalled. The following sample code demonstrates how to parse video content from V2TimMessage:
In the SDK for Flutter 5.0.4 or later, multimedia message online URLs (url) will not be returned when users get the message list. They need to be obtained by calling the getMessageOnlineUrl API (details). In the SDK for Flutter SDK 5.0.4 or later, multimedia message local URLs (localurl) will no longer be returned by default. They will be returned only after you download messages successfully by calling the downloadMessage API (details).
if(message.elemType == MessageElemType.V2TIM_ELEM_TYPE_VIDEO){
// Parse the video message attributes such as thumbnail, playback address, width and height, and size
message.videoElem.UUID;
message.videoElem.duration;
message.videoElem.localSnapshotUrl;
message.videoElem.localVideoUrl;
message.videoElem.snapshotHeight;
message.videoElem.snapshotPath;
// ...
}

// Get the multimedia message URL
V2TimValueCallback<V2TimMessageOnlineUrl> getMessageOnlineUrlRes =
await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.getMessageOnlineUrl(
msgID: '', // Message ID
);
if (getMessageOnlineUrlRes.code == 0) {
// Obtained successfully
}

// Download a multimedia message
V2TimCallback downloadMessageRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.downloadMessage(
msgID: '', // Message ID
messageType: 5, // Message type
imageType: 0, // Image type. This field is valid only for image messages.
isSnapshot: false // Whether it is a video thumbnail. This field is valid only for video messages.
);
if (downloadMessageRes.code == 0) {
// Download successful
}

Audio message

The SDK for Flutter will download audio messages when free, which can be directly used by you and will be cleared when the application is uninstalled. The following sample code demonstrates how to parse audio content from V2TimMessage:
In the SDK for Flutter 5.0.4 or later, multimedia message online URLs (url) will not be returned when users get the message list. They need to be obtained by calling the getMessageOnlineUrl API (details). In the SDK for Flutter SDK 5.0.4 or later, multimedia message local URLs (localurl) will no longer be returned by default. They will be returned only after you download messages successfully by calling the downloadMessage API (details).
if(message.elemType == MessageElemType.V2TIM_ELEM_TYPE_SOUND){
// Parse the playback address, local address, size, and duration of the audio message.
message.soundElem.UUID;
message.soundElem.dataSize;
message.soundElem.duration;
message.soundElem.localUrl;
message.soundElem.url;
// ...
// Get the multimedia message URL
V2TimValueCallback<V2TimMessageOnlineUrl> getMessageOnlineUrlRes =
await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.getMessageOnlineUrl(
msgID: '', // Message ID
);
if (getMessageOnlineUrlRes.code == 0) {
// Obtained successfully
}

// Download a multimedia message
V2TimCallback downloadMessageRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.downloadMessage(
msgID: '', // Message ID
messageType: 4, // Message type
imageType: 0, // Image type. This field is valid only for image messages.
isSnapshot: false // Whether it is a video thumbnail. This field is valid only for video messages.
);
if (downloadMessageRes.code == 0) {
// Download successful
}
}

File message

The SDK for Flutter will download file messages when free, which can be directly used by you and will be cleared when the application is uninstalled. The following sample code demonstrates how to parse file message content from V2TimMessage:
In the SDK for Flutter 5.0.4 or later, multimedia message online URLs (url) will not be returned when users get the message list. They need to be obtained by calling the getMessageOnlineUrl API (details). In the SDK for Flutter SDK 5.0.4 or later, multimedia message local URLs (localurl) will no longer be returned by default. They will be returned only after you download messages successfully by calling the downloadMessage API (details).

if(message.elemType == MessageElemType.V2TIM_ELEM_TYPE_FILE){
// Parse the filename, size, URL and other info of the file message
message.fileElem.UUID;
message.fileElem.fileName;
message.fileElem.fileSize;
message.fileElem.localUrl;
message.fileElem.path;
message.fileElem.url;
// Get the multimedia message URL
V2TimValueCallback<V2TimMessageOnlineUrl> getMessageOnlineUrlRes =
await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.getMessageOnlineUrl(
msgID: '', // Message ID
);
if (getMessageOnlineUrlRes.code == 0) {
// Obtained successfully
}

// Download a multimedia message
V2TimCallback downloadMessageRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.downloadMessage(
msgID: '', // Message ID
messageType: 6, // Message type
imageType: 0, // Image type. This field is valid only for image messages.
isSnapshot: false // Whether it is a video thumbnail. This field is valid only for video messages.
);
if (downloadMessageRes.code == 0) {
// Download successful
}
}

Geographical location message

After receiving the geographical location message, the receiver can parse the latitude and longitude information directly from locationElem. The following sample code demonstrates how to parse the geographical location content from V2TimMessage:

if(message.elemType == MessageElemType.V2TIM_ELEM_TYPE_LOCATION){
// Parse the geographical location information such as latitude, longitude, and description
message.locationElem.desc;
message.locationElem.latitude;
message.locationElem.longitude;
}

Emoji message

The SDK only provides a message passthrough channel for an emoji message. For message content fields, see faceElem (details), where the contents of index and data are customized by the user.
For example, the sender can set index to 1 and data to x12345 to indicate the smile emoji. The receiver parses the received emoji message as 1 and x12345 and displays the message as the smile emoji according to the preset rules.
The following sample code demonstrates how to parse the emoji content from V2TIMMessage:
if (message.elemType == MessageElemType.V2TIM_ELEM_TYPE_FACE) {
message.faceElem.data;
message.faceElem.index;
}

Group tip message

Group tip messages are tips received by users other than ordinary messages in a group chat, such as "The admin removed alice from the group chat" and "bob renamed the group "xxxx"".
Note:
Group tip messages apply to group members only.
There are many types of group tip messages. For more information, see the definition of V2TIMGroupTipsType (details).
After receiving a group tip message, the receiver generally needs to:
1. Parse all fields in V2TIMGroupTipsElem.
2. Identify the message type according to type.
3. Merge other fields into the content for display according to the type.
Example: V2TIM_GROUP_TIPS_TYPE_GROUP_INFO_CHANGE is parsed from the type, indicating that this is a notification of group profile change. The receiver can get the operator information from opMember and the new group name from groupChangeInfoList. At this point, the receiver can merge the "operator" and "new group name" to create a group tip, such as "Alice renamed the group as "group123"".
The following sample code demonstrates how to parse the tip content from V2TIMMessage:
if(message.elemType == MessageElemType.V2TIM_ELEM_TYPE_GROUP_TIPS){
message.groupTipsElem.groupID; // Group
message.groupTipsElem.type; // Group tip type
message.groupTipsElem.opMember; // Operator profile
message.groupTipsElem.memberList; // User profile being operated
message.groupTipsElem.groupChangeInfoList; // Group information change details
message.groupTipsElem.memberChangeInfoList; // Group member change information
message.groupTipsElem.memberCount; // Number of current online group members
}

Receiving Messages Containing Multiple Element Objects

1. Parse the first element object from the Message object.
2. Get the next element object through the nextElem method of the first element object. If the next object exists, an element object instance is returned; otherwise, null is returned.
Sample code:
if(message.textElem.nextElem!=null){
// There is a next message
}