English | 简体中文

Notice: If you open a pull request in TUIKit Android or iOS and the corresponding changes are successfully merged, your name will be included in README.md with a hyperlink to your homepage on GitHub.

Instant Messaging

Product Introduction

Build real-time social messaging capabilities with all the features into your applications and websites based on powerful and feature-rich chat APIs, SDKs and UIKit components.

Android Experience App iOS Experience App

TUIKit is a UI component library based on Tencent Cloud IM SDK. It provides universal UI components to offer features such as conversation, chat, search, relationship chain, group, and audio/video call features.

Image Download

Tencent Cloud branch download address: Download

SDK Download

Native SDK Download Address Integration Guide Update Log
Android GitHub (Recommended) [Quick Integration] TUIKit Integration (Android)
[General Integration] SDK Integration (Android)
Update Log (Native)
iOS GitHub (Recommended) [Quick Integration] TUIKit Integration (iOS)
[General Integration] SDK Integration (iOS)
Mac GitHub (Recommended) [General Integration] SDK Integration (Mac)
Windows GitHub (Recommended) [General Integration] SDK Integration (Windows)

TUIKit Integration

功能模块 平台 文档链接
TUIKit Library iOS TUIKit-iOS Library
Android TUIKit-Android Library
Quick Integration iOS TUIKit-iOS Quick Integration
Android TUIKit-Android Quick Integration
Modifying UI Themes iOS TUIKit-iOS Modifying UI Themes
Android TUIKit-Android Modifying UI Themes
Setting UI Styles iOS TUIKit-iOS Setting UI Styles
Android TUIKit-Android Setting UI Styles
Adding Custom Messages iOS TUIKit-iOS Adding Custom Messages
Android TUIKit-Android Adding Custom Messages
Implementing Local Search iOS TUIKit-iOS Implementing Local Search
Android TUIKit-Android Implementing Local Search
Integrating Offline Push iOS TUIKit-iOS Integrating Offline Push
Android TUIKit-Android Integrating Offline Push

Differences Between the Basic Edition and the Enhanced Edition

  • SDK added the Enhanced Edition from SDK 5.4. The original edition is called the Basic Edition.
  • Both the Basic Edition and Enhanced Edition support V2 APIs. However, the Enhanced Edition no longer supports legacy APIs while the Basic Edition still supports legacy APIs.
  • If you have not integrated legacy APIs, we recommend that you directly use V2 APIs and choose the Enhanced Edition SDK.
  • If you have integrated legacy APIs, we recommend that you upgrade to V2 APIs and gradually transition to the Enhanced Edition SDK.
  • Compared with the Basic Edition, the Enhanced Edition has greatly reduced the SDK size and installation package increment.
  • Compared with the Basic Edition, the Enhanced Edition provides more new features.
  • Subsequent development of new features will only be supported on the Enhanced Edition. The Basic Edition supports only routine maintenance and fixing of existing problems.
  • Enhanced Edition Pro has been released from SDK 6.8 version which supports dual line acceleration on network layer and provides better performance for bad network environment.

Comparison of the SDK sizes

Platform Item Basic Edition Enhanced Edition
Android aar size 7.8 MB 3.1 MB
iOS framework size 57.7 MB 11.2 MB

Comparison of the app size increments

Platform Architecture Basic Edition Enhanced Edition
apk increment armeabi-v7a 3.2 MB 1.1 MB
arm64-v8a 5.2 MB 1.7 MB
ipa increment arm64 2.1 MB 1.1 MB

Guidelines for Upgrading IMSDK to V2 APIs

API Upgrade Guidelines

Latest Enhanced Edition 7.2.4123 @2023.04.25

SDK

  • Supported clearing messages for topics.
  • Added the notification for conversation deletion.
  • Improved the synchronization speed of conversation lists after login.
  • Supported blocking members kicked out of the group from joining again for non-audio-video groups and community groups.
  • Supported checking western European languages by words in local content moderation.
  • Supported configuring approval options for joining a community group via application or invitation.
  • Android offline push supported second-level message category for vivo phones
  • Supported configuring the number of long polling tasks on console for audio-video groups.
  • Prohibited reverting timestamp for one-to-one message read reporting.
  • The sequence of the read reported group message cannot exceed the sequence of the last group message.
  • Android offline push is now adapted to Android 12 for Huawei, Mi and FCM channels.
  • Fixed the issue that the group name card fields are missing for group messages sent by yourself.
  • Fixed the occasional error that message modification callback is not triggered after a message is modified successfully.
  • Fixed the issue that repeated callback for onMemberKicked after a member is kicked out of a group.
  • Fixed the parsing error for multi-element message in Swift SDK.
  • Fixed the issue that there is no callback for pulling group messages under certain conditions.
  • Fixed the occasional issue that message unread count is not updated in time after a message is recalled.
  • Fixed the occasional OpenSSL crash issue for Android and C/C++.

TUIKit and demo

  • Added call records page.
  • Supported specifying target language for message translation.
  • Supported customizing time limit for message recall in TUIChat
  • Fixed the no response issue when users press Enter to send messages with some third-party input methods

Latest Basic Version 5.1.66 @2021.09.22

Android

  • Removed the feature of getting Wi-Fi information.

Feedback

  • If you encounter any issue when using TIMSDK, please provide feedback on the problem to us so that we can quickly and effectively locate and solve the issue for you.
  • TIMSDK Issue Feedback Guidelines
S
Description
Free Chat SDK (IM SDK) — 1,000 MAU/month free forever with push notifications & no concurrency limits. Build in-app messaging with chat API, UIKit & send message. Supports Android, iOS, Flutter, Web, React Native, uni-app, HarmonyOS & more.
Readme 1.6 GiB
Languages
Objective-C 33.9%
Java 33.4%
C++ 12%
C 7.8%
Swift 6.9%
Other 5.8%