# Tencent RTC Chat — Unity（Game Solution） > Chat documentation for Unity（Game Solution） platform. ## Core SDK ### Getting Started - [Activate the Service](https://pre.trtc.io/document/74511.md): Tencent Cloud Chat service is an instant messaging SDK that enables developers to integrate messaging and group management features. This guide helps users activate the free plan, retrieve UserSig for authentication, purchase official editions, renew subscriptions, upgrade plans, and enable automatic renewal. It provides step-by-step instructions to quickly start using Chat and manage your application versions effectively. - [Run Demo](https://pre.trtc.io/document/41656.md): The Unity Chat SDK Quickstart Guide provides step-by-step instructions for developers to integrate Tencent Cloud's Chat SDK into Unity projects across multiple platforms including iOS, Android, macOS, Windows, and Web. It covers environment requirements, enabling the service, SDK integration, dependency loading, SDK initialization, test account login, message sending, and WebGL support setup, helping developers quickly build chat functionalities with Tencent RTC. - [SDK Integration](https://pre.trtc.io/document/46263.md): The Chat SDK for Unity is a software development kit designed to enable chat functionalities within Unity projects. This quickstart guide helps developers configure and integrate the SDK by outlining environment requirements, dependency setup via UPM, and testing procedures using a demo project. It supports Unity 2019.4.15f1 or later on multiple platforms including Android and iOS, facilitating early-stage development and API testing. - [SDK Initialization](https://pre.trtc.io/document/48570.md): The Unity Chat SDK is a communication SDK that requires initialization before using its core features like messaging, login, and group management. This guide explains how to prepare your SDKAppID, configure the SDK settings including local data and log paths, register global event listeners for handling connection and message events, and call the initialization API. Follow these steps to properly set up the Chat SDK in your Unity application and ensure stable operation. - [Login and Logout](https://pre.trtc.io/document/48571.md): The Unity Chat SDK is a messaging SDK that requires users to authenticate via the login API to access messaging and conversation features. This guide explains how to perform login, retrieve the logged-in user ID, check login status, handle multi-client login policies, and manage logout and account switching. It also covers common error handling scenarios such as dealing with expired tickets and user kickouts, providing developers with essential steps to integrate and manage user authentication effectively. ### Users - [User Profile](https://pre.trtc.io/document/48859.md): The Unity SDK offers user profile management capabilities within the Tencent RTC suite, allowing users to set and retrieve nicknames, profile photos, and statuses. It supports querying and modifying personal and friends' profiles while enabling access to non-friend user profiles in read-only mode. The SDK also includes relationship chain event listeners to handle friend additions, deletions, requests, and blacklist management, providing developers with comprehensive tools to manage social interactions effectively. - [User Online Status](https://pre.trtc.io/document/53436.md): The Unity native SDK version 6.3 and later offers user status management capabilities, allowing users to set and query both general and custom statuses. This SDK feature targets developers integrating real-time communication functionalities, enabling them to manage user presence such as online, offline, or custom states like "Listening to music". It supports status synchronization across devices and provides callbacks for status changes, enhancing user interaction experiences in applications. - [Friend Management](https://pre.trtc.io/document/49563.md): The Chat SDK for Unity provides friend management capabilities, allowing users to add, delete, and manage friend relationships. This guide explains how to get contacts, add friends with or without approval, handle friend requests, and delete friends using the SDK APIs. Key steps include calling FriendshipAddFriend, setting approval permissions, and processing callbacks for friend request responses. - [Friend List](https://pre.trtc.io/document/49565.md): The Unity SDK provides APIs for managing friend lists, allowing users to group friends into categories such as "Classmates at university" and "Coworkers". This API reference details methods for creating, deleting, renaming, and retrieving friend lists, as well as adding or removing friends from these lists. It is designed for developers integrating friend list management features into Unity applications using Tencent RTC. - [Block Lists](https://pre.trtc.io/document/49567.md): Tencent IM SDK for Unity provides APIs to manage user blocklists, allowing developers to block or unblock users and retrieve the list of blocked users. This guide details the use of FriendshipAddToBlackList, FriendshipDeleteFromBlackList, and FriendshipGetBlackList APIs to control message blocking behavior and handle related error codes effectively. ### Group Channels - [Overview](https://pre.trtc.io/document/48169.md): The Chat SDK offers various group types including work groups, public groups, meeting groups, communities, and audio-video groups to support diverse chat scenarios. This overview explains the capabilities and limits of each group type, such as member roles, join approvals, and message history management. It also highlights the requirements for using community groups and configuration options for enabling message history retrieval. The Chat SDK is designed for developers to implement flexible and scalable group communication features. - [Group Channel Settings](https://pre.trtc.io/document/48463.md): The Unity group management feature in Tencent IM SDK enables developers to create, join, retrieve, leave, and disband groups. This guide explains how to set up group event listeners to receive notifications for group activities, create groups with specific attributes, and join groups based on their types, including work groups by invitation and free-to-join groups like meeting or audio-video groups. Key steps and sample code snippets are provided for seamless integration. - [Group Channel Profile](https://pre.trtc.io/document/50287.md): The Unity SDK provides APIs for managing group profiles and configuring group message receiving options. Developers can retrieve and modify group information, with permissions varying by group type, and control message notifications through configurable receiving options. This enables flexible group communication management for applications using Tencent RTC. - [Member Management (Mute & Ban)](https://pre.trtc.io/document/50319.md): The Unity Group Member Management SDK provides APIs for managing group members, including retrieving member lists with role-based filters, paged data pulling, muting members, removing members, granting admin permissions, and transferring group ownership. It is designed for developers building real-time communication applications who need efficient and flexible group member management capabilities. - [Member Profile](https://pre.trtc.io/document/50320.md): The Group Member Profile Management APIs for Unity SDK provide methods to retrieve and modify group member profiles efficiently. Users can batch get member profiles using GroupGetMemberInfoList and update profile details such as name cards and custom fields via GroupModifyMemberInfo. These APIs enable group owners and admins to manage group member information effectively within Unity applications. - [Group Channel Attributes](https://pre.trtc.io/document/50321.md): The Unity SDK provides APIs for managing group attributes in audio-video groups (AVChatRoom), enabling seat management in audio chat rooms. Developers can initialize, delete, retrieve, and listen for changes to group attributes using GroupInitGroupAttributes, GroupDeleteGroupAttributes, GroupGetGroupAttributes, and SetGroupAttributeChangedCallback. These APIs support up to 16 attributes with size and rate limits, allowing efficient client-side group attribute management without console configuration. - [Group Channel Counter](https://pre.trtc.io/document/53432.md): Tencent Cloud Chat SDK Unity API provides group counter capabilities to manage integer data counters within groups, such as viewer counts and likes. This API documentation covers key methods including setting, incrementing, decrementing, and retrieving group counters, along with callback notifications. It supports all group types except topic-enabled community groups and is available in Pro, Pro Plus, and Enterprise editions. Developers can manage up to 20 counters per group with defined limits on API calls to ensure performance and reliability. ### Messages - [Overview](https://pre.trtc.io/document/48869.md): The Tencent Cloud Chat SDK provides a Message class that encapsulates message details for sending and receiving chat messages. This API documentation explains the meanings and usage of various message fields including sender information, message status, read receipts, custom data, and message types. It supports one-to-one and group messaging scenarios, enabling developers to manage chat interactions effectively. - [Send a Message](https://pre.trtc.io/document/48572.md): The MsgSendMessage API in the TencentIMSDK Unity SDK enables developers to send text, image, voice, video, file, location, emoji, and custom messages. This API supports both one-to-one and group conversations by specifying conversation IDs and types. It provides asynchronous callbacks to handle message sending results, facilitating rich media communication within Unity applications. - [Receive a Message](https://pre.trtc.io/document/48573.md): The RecvNewMsgCallback API in the Unity SDK enables developers to listen for and receive various message types including text, custom, and rich media messages. This guide explains how to add and remove message listeners using TencentIMSDK, and how to handle different message elements such as images, videos, audio, files, emojis, and group tips. It is designed for developers integrating messaging features into Unity applications to ensure timely and efficient message reception. - [Message History](https://pre.trtc.io/document/48871.md): The MsgGetMsgList API in the Unity SDK enables pulling historical one-to-one and group messages from both local storage and the cloud. It supports pagination and handles network exceptions by returning locally stored messages. Cloud message retention periods depend on the edition, ranging from 7 to 90 days, with options for extension. This API is designed for meeting groups and excludes audio-video groups. Developers can use this API to efficiently retrieve historical messages with detailed control over pagination parameters. - [Forward Messages](https://pre.trtc.io/document/48873.md): The Unity guide for Tencent IM SDK explains how to implement message combining and forwarding features. It is designed for developers using the Unity platform to create chat applications that require combining multiple messages into one and forwarding them. The guide provides step-by-step instructions on creating combined messages with titles and digests, sending them, receiving and parsing combined messages, and forwarding individual messages using TencentIMSDK APIs. - [Edit Message](https://pre.trtc.io/document/53444.md): The Unity Chat SDK provides a message modification feature that enables any participant in a conversation to modify a successfully sent message. This SDK supports syncing the modified message to all conversation members and is available on native SDK version 6.2.2363 or later. Developers can use the MsgModifyMessage API to change message content such as custom strings and text elements, and listen for message updates through the SetMsgUpdateCallback API to handle modifications in real time. - [Delete Message](https://pre.trtc.io/document/48877.md): The Unity SDK provides message deletion capabilities for both local and cloud messages. It allows developers to delete messages locally, marking them as deleted and preventing further retrieval unless the app is reinstalled. For cloud messages, deletion removes them both locally and from the cloud permanently. This feature supports batch deletion of up to 30 messages per call within the same conversation and enforces rate limits. It is designed for developers managing message lifecycle in Unity applications using Tencent RTC. - [Clear History Messages](https://pre.trtc.io/document/48879.md): Tencent IM SDK for Unity provides APIs to clear message history in both one-to-one and group conversations. This functionality allows developers to remove all messages from a conversation locally and from the cloud without deleting the conversation itself. The key method MsgClearHistoryMessage supports clearing messages by specifying the conversation ID and type, enabling effective message management in chat applications. - [Recall a Message](https://pre.trtc.io/document/48881.md): The Tencent IM SDK Unity guide explains how to implement message recall functionality. It shows how senders can recall messages within a configurable time limit by calling MsgRevoke, and how receivers can listen for recall notifications using SetMsgRevokeCallback to update the user interface accordingly. This quickstart provides sample code and key steps for integrating message recall in Unity applications. - [Online Message](https://pre.trtc.io/document/48883.md): Tencent IM SDK for Unity provides a messaging API that allows sending messages only received when the receiver is online, preventing offline storage and roaming. This guide explains how to enable this feature by setting the message_is_online_msg flag and demonstrates implementing a typing indicator in one-to-one chats using the MsgSendMessage API. - [Read Receipt](https://pre.trtc.io/document/48885.md): The Unity Message Read Receipt feature in Tencent IM SDK enables senders to know who has read their messages in both one-to-one and group chats. This guide explains how to enable the feature, specify messages requiring read receipts, send and receive read receipt notifications, and retrieve read receipt information. It is intended for developers using the Pro, Pro Plus, or Enterprise editions to implement message read receipt functionality in their Unity applications. - [Query Messages](https://pre.trtc.io/document/48887.md): The MsgFindMessages API in the Unity SDK enables querying local messages by messageID. It supports retrieving received or historically pulled messages stored locally, excluding audio-video group messages which are not saved locally. This API is designed for developers using Tencent RTC to efficiently access local message data within Unity applications. - [Mentions (@)](https://pre.trtc.io/document/50017.md): This guide covers the Tencent IM SDK for Unity, detailing how to send and receive group @ messages in chat conversations. It explains triggering the group member selection UI upon typing '@', creating and sending text @ messages to selected group members or all, and retrieving @ message information from conversation updates. Key steps include listening to input, selecting members, sending messages via MsgSendMessage API, and handling received @ messages using ConvGetConvList and GroupAtInfo APIs. - [Targeted Message](https://pre.trtc.io/document/50018.md): The Unity targeted group messaging SDK enables sending messages to specific members within a group, excluding other members from receiving them. This guide is intended for developers using Unity who want to implement targeted group messaging by specifying recipients via the MsgSendMessage API. It covers key steps including sending messages to selected group members and receiving them like ordinary messages, while noting edition requirements and feature limitations. - [Do Not Disturb](https://pre.trtc.io/document/48891.md): The Unity Chat SDK provides APIs to configure message receiving options for one-to-one and group chats, enabling notification muting features. This guide explains how to use the MsgSetC2CReceiveMessageOpt, MsgGetC2CReceiveMessageOpt, and MsgSetGroupReceiveMessageOpt APIs to control message reception and offline push notifications. It supports setting options for up to 30 users in one-to-one chats and applies to different group types, helping developers manage chat notifications effectively. - [Message Extension](https://pre.trtc.io/document/53445.md): The Unity Message Extension SDK enables developers to configure keys and values for messages to implement polling, group notices, surveys, and other interactive message types. This guide provides step-by-step instructions to set, get, delete, and update message extensions using the native SDK 6.7 or later. It is intended for users with Pro, Pro Plus, or Enterprise editions who want to enhance messaging capabilities in their Unity applications. Key actions include calling the MsgSetMessageExtensions, MsgGetMessageExtensions, and MsgDeleteMessageExtensions APIs with appropriate parameters. ### Conversations - [Conversation Overview](https://pre.trtc.io/document/50019.md): Tencent Cloud IM SDK provides the ConvInfo conversation class to manage one-to-one and group chats. It enables developers to display and update conversation lists, manage unread message counts, pin conversations, handle drafts, and mute notifications. The SDK supports unlimited local conversation storage and cloud storage up to 100 conversations by default, with options to increase limits through upgraded editions. This overview explains the core attributes of conversations and the storage policies applicable to Tencent Cloud IM users. - [Conversation List](https://pre.trtc.io/document/50020.md): The Unity Chat SDK offers conversation list management features that allow developers to retrieve recent conversations, update the list automatically, and listen for conversation changes. This guide explains how to get the conversation list, add and remove conversation listeners, and send messages without affecting the last message preview, enabling efficient chat UI implementation. - [Get Conversations](https://pre.trtc.io/document/48843.md): The Chat SDK Unity API provides the ConvGetConvInfo method to retrieve detailed information about one or multiple specified conversations. This API supports different conversation types including group and client-to-client (C2C), enabling developers to efficiently access conversation metadata. The documentation includes sample code illustrating how to prepare conversation parameters and handle asynchronous responses. - [Unread Count](https://pre.trtc.io/document/48846.md): The Unity Chat SDK guide explains how to manage unread message counts across multiple conversations. It is designed for developers building chat applications who need to display badges for unread messages, calculate total unread counts, receive notifications on unread count changes, and clear unread counts for individual or all conversations. Key steps include calling APIs to get total unread counts, setting callbacks for unread count changes, and clearing unread counts for one-to-one and group chats. - [Pin Conversations](https://pre.trtc.io/document/48849.md): The Unity conversation pinning feature in Tencent IM SDK allows developers to fix one-to-one or group conversations at the top of the conversation list to facilitate quick access. This guide explains how to use the ConvPinConversation API to pin or unpin conversations, how pinned conversations are ordered, and how to listen for pinned status changes using SetConvEventCallback. It helps Unity developers implement conversation pinning functionality efficiently. - [Delete Conversations](https://pre.trtc.io/document/49498.md): The Chat SDK provides a feature to delete conversations, allowing users to remove historical one-to-one or group messages after deleting a friend or leaving a group. This operation deletes messages from both the client and server permanently. The guide explains how to call the ConvDelete API to perform conversation deletion and notes the default multi-client sync settings. - [Conversation Draft](https://pre.trtc.io/document/48847.md): The Tencent IM SDK Unity guide explains how to save and manage conversation drafts using the ConvSetDraft API. It helps Unity developers enable users to save unfinished text messages locally, switch between chat windows, and resume drafts later. The guide includes key steps and sample code for setting a conversation draft in a local database without server synchronization. - [Conversation Mark](https://pre.trtc.io/document/53446.md): Tencent IM SDK for Unity provides APIs to mark conversations as favorite, collapsed, hidden, or unread, enabling customized conversation management. This SDK feature requires Pro, Pro Plus, or Enterprise editions and native SDK 6.5 or later. Key APIs include ConvMarkConversation for marking, SetConvEventCallback for listening to mark changes, and ConvGetConversationListByFilter for retrieving marked conversations with pagination support. - [Conversation Group](https://pre.trtc.io/document/53447.md): Tencent IM SDK for Unity provides APIs to manage conversation groups, enabling developers to create, delete, rename groups, and manage conversations within them. This SDK supports grouping conversations such as "Product experience" or "R&D" to organize chats effectively. The feature requires the Premium edition and native SDK version 6.5 or later. Key operations include creating groups with up to 20 allowed, adding or removing conversations, retrieving group lists, and handling notifications for group changes. ### Search - [Searching for Message](https://pre.trtc.io/document/50066.md): The Unity SDK Message Search API provides functionality to search local messages, including received and historical messages, within conversations. It supports filtering by keywords, sender IDs, message types, conversation scope, time range, and pagination. This API is available exclusively in the Ultimate edition and returns results grouped by conversation or within a specified conversation, facilitating efficient message retrieval for developers. - [Searching for Friend](https://pre.trtc.io/document/50068.md): The FriendshipSearchFriends API in the Unity SDK allows searching for locally stored user profiles, including contacts and pulled user data. This API enables developers to specify search keywords and define the search scope by userID, nickName, or remark fields, facilitating efficient local user profile retrieval within Tencent RTC. - [Searching Group](https://pre.trtc.io/document/50070.md): The Tencent IM SDK Unity API GroupSearchGroups allows searching for locally stored groups, such as joined groups and pulled group profiles. Users can specify search keywords and define the search scope by groupID and groupName fields. This API reference includes sample code and parameter details to help developers implement local group search functionality effectively. - [Searching for Group Member](https://pre.trtc.io/document/50074.md): The Unity SDK provides the GroupSearchGroupMembers API to search for locally stored group members by keywords and group IDs. This API supports searching by memberUserID, memberNickName, memberRemark, and memberNameCard fields within specified groups or across all groups if no group ID is specified. It is designed for local group member search and does not support audio-video groups (AVChatRoom) where members are not stored locally. - [Cloud Search Messages](https://pre.trtc.io/document/73389.md): Cloud message search is a powerful SDK feature within Tencent RTC that enables users to quickly find desired messages from complex data across all or specified sessions. Designed for Pro Plus and Enterprise customers, it supports keyword-based, sender-specific, and message type filtering with customizable time ranges. This feature enhances app user experience and operational efficiency by providing precise and paginated search results through MessageSearchParam and MessageSearchResult classes. - [Cloud Search Users](https://pre.trtc.io/document/73390.md): The Search Cloud Users API in Tencent IM SDK for Unity allows developers to find user profiles by user ID, nickname, gender, and other criteria. This API supports advanced user search with parameters such as keyword matching logic, birthday range, and pagination through cursors. It is designed for social scenarios requiring user discovery, such as adding friends or following users. The interface returns detailed user information from the cloud, including friend status, and requires SDK version 8.6.7020 or later with Pro Plus or Enterprise licenses for full features. - [Cloud Search Channels](https://pre.trtc.io/document/73391.md): The GroupSearchCloudGroups API in the Unity SDK enables searching for cloud groups by keywords such as group ID and group name. It supports configurable search logic, result count, and pagination through cursors. This API is designed for developers to efficiently retrieve group profiles in Tencent RTC environments, requiring version 8.6.7020 or later and Pro Plus or Enterprise for full functionality. - [Cloud Search Channel Members](https://pre.trtc.io/document/73392.md): The GroupSearchCloudGroupMembers API in the Unity SDK allows searching for cloud group members by memberID, nickName, and nameCard. This API supports keyword matching with configurable logic, group ID filtering, and pagination. It is available from version 8.6.7020 and requires Pro Plus or Enterprise subscription. The API returns detailed search results including member lists and cursors for continued queries. ### Client APIs - [Client APIs](https://pre.trtc.io/document/40125.md): The Unity Chat SDK API Reference provides comprehensive details on APIs for managing conversations, friendships, groups, messages, user profiles, and SDK initialization. Designed for developers using Tencent Cloud's Chat SDK on the Unity platform, it enables efficient integration of chat functionalities including conversation handling, friend management, group operations, login control, and message processing. ### Changelog - [Changelog](https://pre.trtc.io/document/41800.md): The Unity SDK release notes document details version updates, new features, API enhancements, and bug fixes for Tencent RTC. It supports multiple platforms including Windows, iOS, Mac M1, and WebGL, enabling developers to integrate messaging, offline push notifications, and group management functionalities. Key updates include custom notification titles, cloud user search APIs, message reaction interfaces, and improved callback handling.