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

Client APIs

TencentCloudChat

TencentCloudChat is the namespace of the Chat Web SDK and provides the static method create() for creating SDK instances, the event constant EVENT, and the type constant TYPES, and the signaling constant TSignaling.

Initialization

API
Description
create
Creates an SDK instance.

SDK Instance

Term
Description
Message
Message indicates the content to be sent and carries multiple attributes which specify whether you are the sender, the sender account, the message generation time, and so on.
Conversation
Two types of conversation are available:
Client to Client (C2C): A one-to-one chat, involving only two participants.
GROUP: A group chat, involving more than two participants.
Profile
Profile describes the basic information of a user, including the nickname, gender, personal signature, and profile photo URL.
Friend
Friend describes the basic information of a friend, including the remarks and friend list.
FriendApplication
FriendApplication describes the basic information of a friend request, including the friend source and remarks.
FriendGroup
FriendGroup describes the basic information of a friend group, including the friend group name and members.
Group
Group indicates a communication system for group chatting, including Work Group, Public Group, Meeting Group, Audio-Video Group, and Community Group.
GroupMember
GroupMember indicates the basic information of each group member, such as the ID, nickname, role, and the time of joining the group.
Group tip
A group tip is generated when an event such as adding or deleting group member occurs. The access side can configure whether to display group tips to group members.
Group system message
For example, when a user requests to join a group, the group admin receives a system message. After the admin accepts or rejects the request, the Chat SDK returns the result to the access side, which then displays the result to the user.
Message display on screen
The sent messages, including text segments and images, are displayed on the computer or phone screen.

Event

API
Description
on
Enables event listening.
off
Disables event listening.

Plugin registration

API
Description
registerPlugin
Registers a plugin.

Setting log level

API
Description
setLogLevel
Sets the log level. Logs below this level will not be printed.

SDK instance termination

API
Description
destroy
Terminates an SDK instance. The SDK will log out, disconnect the WebSocket persistent connection, and then release resources.

Login

API
Description
login
Logs in to the Chat SDK using userID and userSig.
logout
Logs out to the Chat SDK.
isReady
Indicates the SDK enter the ready state or not.
getLoginUser
Get the userID of the logged-in user. If the user is not logged in, it returns an empty string ('').

Message

API
Description
createTextMessage
Creates a text message.
createTextAtMessage
Creates a text message with the @ notification feature.
createImageMessage
Creates an image message.
createAudioMessage
Creates an audio message.
createVideoMessage
Creates a video message.
createCustomMessage
Creates a custom message.
createFaceMessage
Creates an emoji message.
createFileMessage
Creates a file message.
createLocationMessage
Creates a location message.
createMergerMessage
Creates a combined message.
downloadMergerMessage
Downloads a combined message.
createForwardMessage
Creates a forward message.
sendMessage
Sends a message.
revokeMessage
Recalls a message.
resendMessage
Sends a message again.
deleteMessage
Deletes a message.
translateText
Translates a message.
setMessageExtensions
Sets message extensions.
getMessageExtensions
Gets message extensions.
deleteMessageExtensions
Deletes message extensions.
addMessageReaction
Add message reactions. This interface allows for scenarios such as "emoji reactions" to be implemented.
removeMessageReaction
Remove message reactions.
getMessageReactions
Retrieve information of message reactions.
getAllUserListOfMessageReaction
Paginate and retrieve the user list for a specific message reaction.

Conversation

API
Description
modifyMessage
Modifies a message.
getMessageList
Gets the message list.
getMessageListHopping
Pulls the conversation message list by specified sequence or time range.
sendMessageReadReceipt
Sends message read receipts.
getMessageReadReceiptList
Pulls the list of message read receipts.
getGroupMessageReadMemberList
Pulls the list of members who have (or have not) read a group message.
findMessage
Queries local messages in a specified conversation by messageID.
setMessageRead
Marks a message as read.
getConversationList
Gets the conversation list.
getConversationProfile
Gets the conversation information.
deleteConversation
Deletes a conversation.
setConversationDraft
Set conversation draft.
clearHistoryMessage
Clears the chat history with a user from local storage and the cloud (without deleting the conversation).
pinConversation
Pins/Unpins a conversation to/from top.
setAllMessageRead
Marks the unread messages of all conversations as read.
setMessageRemindType
Sets the conversation message notification type. You can use this API to mute notifications or reject messages.
getTotalUnreadMessageCount
Gets the total unread message count of conversations.

Conversation group

API
Description
setConversationCustomData
Sets custom conversation data.
markConversation
Marks a conversation.
getConversationGroupList
Gets the list of conversation groups.
createConversationGroup
Creates a conversation group.
deleteConversationGroup
Deletes a conversation group.
renameConversationGroup
Renames a conversation group.
addConversationsToGroup
Adds a conversation to a conversation group.
deleteConversationsFromGroup
Deletes conversations from a conversation group.

Profile

API
Description
getMyProfile
Gets personal profile.
getUserProfile
Gets other user’s profile.
updateMyProfile
Updates your personal profile.
getBlacklist
Gets your blocklist.
addToBlacklist
Adds a user to the blocklist.
removeFromBlacklist
Removes a user from the blocklist.

User status

API
Description
setSelfStatus
Sets one's own custom status.
getUserStatus
Queries a user's status.
subscribeUserStatus
Subscribes to a user's status.
unsubscribeUserStatus
Unsubscribes from a user's status.

Relationship Chain

API
Description
getFriendList
Gets the contacts in the SDK cache.
addFriend
Adds friends.
deleteFriend
Deletes friends.
checkFriend
Verifies friend relationship.
getFriendProfile
Gets the friend data and profile data of a specified user.
updateFriend
Updates the relationship chain data of friends.
getFriendApplicationList
Gets the friend request list in the SDK cache.
acceptFriendApplication
Accepts a friend request.
refuseFriendApplication
Rejects a friend request.
deleteFriendApplication
Deletes a friend request.
setFriendApplicationRead
Set a friend request as reads.
getFriendGroupList
Gets list of friend groups in the SDK cache.
createFriendGroup
Creates a friend group.
deleteFriendGroup
Deletes a friend group.
addToFriendGroup
Adds friends to a friend group.
removeFromFriendGroup
Removes friends from a friend group.
renameFriendGroup
Modifies the name of a friend group.

Group

API
Description
getGroupList
Gets the group list.
getGroupProfile
Gets the group profile.
createGroup
Creates a group.
dismissGroup
Disbands a group.
updateGroupProfile
Modifies the group profile.
joinGroup
Requests to join a group.
quitGroup
Quits a group.
searchGroupByID
Searches for a group.
getGroupOnlineMemberCount
Gets the number of online users in an audio-video group.
changeGroupOwner
Transfers the group ownership.
getGroupApplicationList
Gets the list of requests to join a group.
handleGroupApplication
Processes requests to join the group.
initGroupAttributes
Initializes group attributes.
setGroupAttributes
Sets group attributes.
deleteGroupAttributes
Deletes group attributes.
getGroupAttributes
Gets group attributes.
setGroupCounters
Sets group counters.
increaseGroupCounter
Increases the specified group counters.
decreaseGroupCounter
Decreases the specified group counters.
getGroupCounters
Gets the specified group counters.

Group member

API
Description
getGroupMemberList
Gets the group member list.
getGroupMemberProfile
Gets a group member’s profile.
addGroupMember
Adds a group member.
deleteGroupMember
Deletes a group member.
setGroupMemberMuteTime
Configures the muting period.
setGroupMemberRole
Modifies the group member’s role.
setGroupMemberNameCard
Sets the name card for a group member.
setGroupMemberCustomField
Sets a custom field for a group member.
markGroupMemberList
Marks group members.

Topic

API
Description
getJoinedCommunityList
Gets the list of community groups the current user has joined.
createTopicInCommunity
Creates a topic in a community group.
deleteTopicFromCommunity
Deletes a topic in a community group.
updateTopicProfile
Updates a topic profile in a community group.
getTopicList
Gets the topic list in a community group.

Signaling

API
Description
addSignalingListener
Listens for a signaling event.
removeSignalingListener
Removes listener for a signaling event.
invite
Invites someone.
inviteInGroup
Invites members in a group.
cancel
The inviter cancels the invitation.
accept
The invitee accepts the invitation.
reject
The invitee rejects the invitation.
getSignalingInfo
Gets signaling info from a message.
modifyInvitation
Modifies a invitation.