- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Integration Solution (UI Included) (Recommended)
- Integration Solution (No UI)
- 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
- Message Translation
- Conversation
- Group
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- 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
- Webhook Mutual Authentication Configuration Guide
- Use Cases
- AI Chatbot
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- Web-Based Interactive Live Streaming
- Muting/Unmuting Group Members
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- Discord Implementation Guide
- How to Integrate Chat into Games
- Flutter Avchatroom
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Integration Solution (UI Included) (Recommended)
- Integration Solution (No UI)
- 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
- Message Translation
- Conversation
- Group
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- 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
- Webhook Mutual Authentication Configuration Guide
- Use Cases
- AI Chatbot
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- Web-Based Interactive Live Streaming
- Muting/Unmuting Group Members
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- Discord Implementation Guide
- How to Integrate Chat into Games
- Flutter Avchatroom
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
IM SDK Concepts
Conversation: there are two types of conversations in the IM SDK. One is the C2C conversation, which is a one-to-one chat between users with messages read and sent within the conversation. The other is the group conversation, which is a group chat where all group members can receive messages.
Message: a message in the IM SDK is the information to be sent to the recipient. A message includes properties such as whether it was read by yourself, whether is was sent successfully, the sender’s account, and the message generation time. A message consists of several Elems, which can be text, images, emojis, and others. A message can contain multiple Elems.
Group ID: a group ID uniquely identifies a group. It is generated by the backend and returned when a group is created.
Introduction to IM SDK Objects
IM SDK objects include the communication manager, conversation, message, and group management. The following table describes them in detail.
| Object | Description | Features |
|---|---|---|
| TIMManager | Manager, which is responsible for basic operations of the IM SDK | Initialization, login, logout, and creating conversations |
| TIMConversation | Conversation, which is responsible for conversation-related operations | Sending messages, obtaining cached conversation messages, and obtaining the unread count |
| TIMMessage | Message | Support various message types including text and image messages |
| TIMGroupManager | Group manager | Creating groups, joining groups, and quitting groups |
| TIMFriendshipManager | Profile and relationship chain manager | Obtaining and modifying profiles and relationship chains |
Calling Sequence
The IM SDK call APIs in the following sequence, and other methods will be called after login succeeds.
|
Step |
Function |
Description |
|---|---|---|
|
Initialization |
||
|
TIMSdkConfig |
Configure basic IM SDK settings such as SDKAppID and the log level |
|
|
TIMManager : init |
Initialize the IM SDK |
|
|
TIMManager : setUserConfig |
Configure basic user settings |
|
|
TIMManager : addMessageListener |
Set the message listener |
|
|
Login |
||
|
TIMManager : login |
Log users in |
|
|
Sending and receiving messages |
TIMManager : getConversation |
Obtain conversations |
|
TIMConversation : sendMessage |
Send messages |
|
|
Group management |
TIMGroupManager |
Managing groups |
|
Logout |
TIMManager : logout |
Log users out |
Yes
No
Was this page helpful?