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.

Image Download

Tencent Cloud branch download address: Download

SDK Download

Native SDK Download Address Integration Guide Update Log
Android GitHub (Recommended) [Quick Integration] SDK Integration (Android)
[General Integration] SDK Integration (Android)
Update Log (Native)
iOS GitHub (Recommended) [Quick Integration] SDK 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

​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​
Module Platform Document Link
Quick IntegrationiOSTUIKit-iOS Quick Integration
AndroidTUIKit-Android Quick Integration
Setting UI StylesiOSSetting UI Styles (TUIKit-iOS)
AndroidSetting UI Styles (TUIKit-Android)
Adding Custom MessagesiOSAdding Custom Messages (TUIKit-iOS)
AndroidAdding Custom Messages (TUIKit-Android)

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.

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 Version 6.5.2803 @2022.07.15

SDK

  • Added the support for marking conversations.
  • Added the support for grouping conversations.
  • Added the support for customizing chat fields.
  • Added the advanced API for pulling conversation list.
  • Supported receiving broadcast messages of audio-video groups.
  • Supported sending notifications of changes to group joining options.
  • Added the support for syncing the changes to group message receiving options across terminals.
  • Optimized the routing logic for persistent connections and added the support for rotation policy.
  • Scheduled to support for Tencent Cloud Japan.
  • Upgraded the authorization ID for HTTPDNS routing requests.
  • Added the support for HTTPDNS routing at Tencent Cloud International.
  • Optimized the start sequence of long polling requests in audio-video groups.
  • Fixed the issue where lastMessage is missing in topic profile under certain conditions.
  • Optimized the logic of pinning a chat to the top.
  • Optimized the statistics collection logic of end-to-end message time.
  • Fixed the issue where duplicate messages occasionally appeared in historical messages due to the resending of failed messages.
  • Fixed the issue where garbled characters were displayed when emojis were sent on earlier mobile phones.
  • Fixed the issue where the faceURL was empty in the message returned by onRecvMessageModified.
  • Fixed the issue where the group invitation signaling sent when the invitee was offline couldn't be received after login.

TUIKit and demo

  • Supported displaying the "Typing..." status in one-to-one chat.
  • Supported displaying the online status of friends in chats and contacts.
  • No longer displayed the "Recall" option 2 minutes after a message was sent.
  • Made custom messages intercompatible across terminals.
  • Fixed the issue where chats were not rearranged in certain scenarios on Android.
  • Removed the TPNS channel from the offline push component.

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%