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

Overview

Message Class

In the Chat SDK, Message indicates the message object that is used to describe the attributes of a message, such as type, content, and conversation ID.
Attribute
Type
Default Value
Description
ID
String
-
Message ID. The rule for concatenating the message ID is ${senderTinyID}-${clientTime}-${random}, which is the same as that for concatenating the message ID of native Chat.
type
String
-
Message type. Valid values:
TencentCloudChat.TYPES.MSG_TEXT - text message
TencentCloudChat.TYPES.MSG_IMAGE - image message
TencentCloudChat.TYPES.MSG_AUDIO - audio message
TencentCloudChat.TYPES.MSG_VIDEO - video message
TencentCloudChat.TYPES.MSG_FILE - file message
TencentCloudChat.TYPES.MSG_CUSTOM - custom message
TencentCloudChat.TYPES.MSG_MERGER - merged message
TencentCloudChat.TYPES.MSG_LOCATION - location message TencentCloudChat.TYPES.MSG_GRP_TIP - group tip message
TencentCloudChat.TYPES.MSG_GRP_SYS_NOTICE - group system notification
payload
Object
-
Message content. Valid values:
TextPayload
ImagePayload
AudioPayload
VideoPayload
FilePayload
CustomPayload
MergerPayload
LocationPayload
FacePayload
GroupTipPayload
GroupSystemNoticePayload
conversationID
String
-
Conversation ID of the message.
conversationType
String
-
Conversation type of the message. Valid values:
TencentCloudChat.TYPES.CONV_C2C --- C2C (one-to-one) conversation
TencentCloudChat.TYPES.CONV_GROUP --- group conversation
TencentCloudChat.TYPES.CONV_SYSTEM --- system conversation
to
String
-
userID of the receiver
from
String
-
userID of the sender. It is set to the ID of the currently logged-in user by default when a message is sent.
flow
String
-
Message flow.
in --- the received message
out --- the sent message
time
Number
-
Message timestamp in seconds
status
String
-
Message status.
unSend --- not sent
success --- sent successfully
fail --- failed to send
isRevoked
Boolean
false
Whether the message is a recalled message. true indicates yes.
priority
String
TencentCloudChat.TYPES.MSG_PRIORITY_NORMAL
Message priority. This attribute applies to group chats.
nick
String
-
Nickname of the message sender. This attribute needs to be set by calling the updateMyProfile API in advance.
avatar
String
-
Profile photo URL of the message sender. This attribute needs to be set by calling the updateMyProfile API in advance.
isPeerRead
Boolean
false
Whether the one-to-one message is read by the receiver. true indicates yes.
nameCard
String
-
Group name card of the sender that sends a non-audio-video group message. This attribute also is called the nickname of the message sender in the group and needs to be set by calling the setGroupMemberNameCard API in advance.
atUserList
Array
-
This field stores the userID values of the group members who are mentioned in the group message.
cloudCustomData
String
''
Custom message data, which is saved in the cloud, will be sent to the receiver, and can still be pulled after the application is uninstalled and reinstalled.
isDeleted
Boolean
false
Whether the message is a deleted message. true indicates yes.
isModified
Boolean
false
Whether the message is a modified message. true indicates yes.
needReadReceipt
Boolean
false
Whether a read receipt is needed. true indicates yes. This attribute applies only to group messages. To use it, you need to purchase the Premium edition package.
readReceiptInfo
Object
-
Message read receipt information
readCount - count of the messages that are read, which can be queried by calling getMessageReadReceiptList API; to query the group members who read the message, call the getGroupMessageReadMemberList.
unreadCount - count of the messages that are not read, which can be queried by calling the getMessageReadReceiptList API.
isBroadcastMessage
Boolean
false
Whether the message is a broadcast message. true indicates yes.
isSupportExtension
Boolean
false
whether the message supports extensions. true indicates yes. To use it, you need to purchase the Premium edition package.
revoker
String | null

userID of the one who recalled the message.

TextPayload

Name
Type
Description
text
String
Text message content

ImagePayload

Name
Type
Description
uuid
String
Unique identifier of an image
imageFormat
Format
Image format type. JPG/JPEG = 1, GIF = 2, PNG = 3, BMP = 4, other = 255
imageInfoArray
Array.<Object>
Image information. Each element contains attributes described as follows:
width - Number
height - Number
url - String - Image address, which can be used for rendering
size - Number - Image size, in bytes
type - Number - 0, Original image; 1, 198p compressed image; 2, 720p compressed image

AudioPayload

Name
Type
Description
uuid
String
Unique identifier
url
String
Audio address, which can be used for playback
size
Number
File size, in bytes
second
Number
Audio duration, in seconds

VideoPayload

Name
Type
Description
videoFormat
String
Video file format
videoSecond
Number
Video file duration, in seconds and of integer type
videoSize
Number
Video file size, in bytes
videoUrl
String
Video file address, which can be used for playback
videoUUID
String
Unique identifier of a video
snapshotWidth
Number
snapshot image width
snapshotHeight
Number
snapshot image height
snapshotUrl
String
snapshot image address, which can be used rendering

FilePayload

Name
Type
Description
uuid
String
Unique identifier
fileName
String
File name
fileUrl
String
File address
fileSize
Number
File size, in bytes

CustomPayload

Name
Type
Description
data
String
"data" field of a custom message
description
String
"description" field of a custom message
extension
String
"extension" field of a custom message

MergerPayload

Name
Type
Description
downloadKey
String
Key for downloading a combined message. If a combined message is large in size, the SDK will store it on the cloud, using this key as the unique identifier of the message.
messageList
Array.<SimplifiedMessage>
List of messages combined
title
String
Title of the combined message, for example, "Chat History of the Talent Center in the Greater Bay Area"
abstractList
String
Digest list. You can set digest information in different formats for different message types, for example: for a text message, the digest can be in the "sender:text" format. For an image message, the digest can be in the "sender:[image]" format. For a file message, the digest can be in the "sender:[file]" format.
compatibleText
String
Compatible text. SDKs of early versions do not support combined messages, and they will send a text message with the content compatibleText by default.
layersOverLimit
Boolean
Whether the number of combination nesting levels exceeds the limit. true: the limit is exceeded, and the message is truncated. Default value: false

GeoPayload

Name
Type
Description
description
String
Related description
latitude
Number
Latitude
longitude
Number
longitude

FacePayload

Name
Type
Description
index
Number
Emoji index, which is customized by the user
data
String
Extra data

GroupTipPayload

Name
Type
Description
groupJoinType
Number
Group joining type. Supported values are as follows:
0 - Default value, indicating that the operation is not a group joining operation.
1 - A user requests to join the group.
2 - A user is invited to the group.
operatorID
String
ID of the user who performs the operation
operationType
Number
Operation type. Supported values are as follows:
1 - A member joins the group.
2 - A member leaves the group. 3 - A group member is removed from the group. 4 - A group member is granted the group admin role. 5 - The group admin role of a group member is revoked. 6 - The group profile is modified. 7 - The profile of a group member is modified. For example, a group member is muted.
10 - An audio-video group member is banned.
11 - An audio-video group member is unbanned.
userIDList
Array.<String>
List of relevant userIDs
newGroupProfile
Object
If a group profile is modified, this field stores the new group profile.
memberList
Array.<Object>
If a group member is muted, this field stores related information. Each element contains attributes described as follows:
userID - String
muteTime - Number - Muting duration, in seconds

GroupSystemNoticePayload

Name
Type
Description
operatorID
String
ID of the user who performs the operation
operationType
Number
Operation type. Supported values are as follows:
1 - A user requests to join the group. 2 - The request to join the group is approved. 3 - The request to join the group is rejected. 4 - A user is removed from the group. 5 - The group is deleted. 6 - The group is created. 7 - A user is invited to the group. 8 - A user leaves the group. 9 - The admin is modified. 10 - The admin is canceled. 11 - The group is repossessed. 12 - A user receives a group joining invitation, and needs to accept or reject the invitation.
13 - A user invites others to join the group, and the invitation is accepted. 14 - A user invites others to join the group, and the invitation is rejected.
15 - Read report synchronized across multiple terminals.
20 - Group message remind type synchronized across multiple terminals.
21 - ban an audio-video group member.
22 - unban an audio-video group member.
23 - a group member invites others to join the group. 255 - A custom notification is triggered.
groupProfile
Object
Profile of the relevant group
userDefinedField
String
User-defined field
handleMessage
Object
Remarks on the processing. For example, if user1 enters remarks on an application to join group1 that requires approval, the admin of group1 will see this field in the group system message.
messageRemindType
String
TencentCloudChat.TYPES.MSG_REMIND_ACPT_AND_NOTE - the SDK receives a message and throws a MESSAGE_RECEIVED event to notify the access side, which then sends a notification.
TencentCloudChat.TYPES.MSG_REMIND_ACPT_NOT_NOTE - the SDK receives a message and throws a MESSAGE_RECEIVED event to notify the access side, which then does not send a notification.
TencentCloudChat.TYPES.MSG_REMIND_DISCARD - the SDK rejects a message.