- Release Notes
- Product Introduction
- Purchase Guide
- Download
- Get Started
- Quick Integration Solution (Including UI Library) (Recommended)
- Self-implementing Integration Solution
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callbacks After Recalling Group Messages
- Callback Mutual Authentication Configuration Guide
- Use Cases
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
- Release Notes
- Product Introduction
- Purchase Guide
- Download
- Get Started
- Quick Integration Solution (Including UI Library) (Recommended)
- Self-implementing Integration Solution
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callbacks After Recalling Group Messages
- Callback Mutual Authentication Configuration Guide
- Use Cases
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
Event Callback APIs
| API | Description |
|---|---|
| TIMAddRecvNewMsgCallback | Adds the callback for receiving new messages |
| TIMRemoveRecvNewMsgCallback | Deletes the callback for receiving new messages |
| TIMSetMsgReadedReceiptCallback | Sets the callback for message read receipts |
| TIMSetMsgRevokeCallback | Sets the callback for message recalls |
| TIMSetMsgElemUploadProgressCallback | Sets the callback for the upload progress of message element files |
| TIMSetGroupTipsEventCallback | Sets the callback for group system messages |
| TIMSetConvEventCallback | Sets the callback for conversation events |
| TIMSetNetworkStatusListenerCallback | Sets the callback for network connection status |
| TIMSetKickedOfflineCallback | Sets the callback for notifications of forced logout |
| TIMSetUserSigExpiredCallback | Sets the callback for user ticket expiration |
| TIMSetOnAddFriendCallback | Sets the callback for adding friends |
| TIMSetOnDeleteFriendCallback | Sets the callback for deleting friends |
| TIMSetUpdateFriendProfileCallback | Sets the callback for updating friends' profiles |
| TIMSetFriendAddRequestCallback | Sets the callback for friend requests |
| TIMSetLogCallback | Sets the callback for logs |
| TIMSetMsgUpdateCallback | Sets the callback for message update notifications returned after messages are modified in the cloud |
IM SDK Initialization APIs
| API | Description |
|---|---|
| TIMInit | Initializes the IM SDK |
| TIMUninit | Uninstalls the IM SDK |
| TIMGetSDKVersion | Gets IM SDK version number |
| TIMSetConfig | Sets extra user configurations |
Login and Logout APIs
| API | Description |
|---|---|
| TIMLogin | Logs in |
| TIMLogout | Logs out |
Conversation APIs
| API | Description |
|---|---|
| TIMConvCreate | Creates a conversation |
| TIMConvDelete | Deletes a conversation |
| TIMConvGetConvList | Gets the conversation list of recent contacts |
| TIMConvSetDraft | Sets the draft of a conversation |
| TIMConvCancelDraft | Deletes the draft of a conversation |
Message APIs
| API | Description |
|---|---|
| TIMMsgSendNewMsg | Sends a new message |
| TIMMsgReportReaded | Marks a message as read |
| TIMMsgRevoke | Recalls a message |
| TIMMsgFindByMsgLocatorList | Locates a message of a conversation by using the message locator |
| TIMMsgImportMsgList | Imports a message list to a conversation |
| TIMMsgSaveMsg | Saves a custom message |
| TIMMsgGetMsgList | Gets the messages of a conversation |
| TIMMsgDelete | Deletes the messages of a conversation |
| TIMMsgDownloadElemToPath | Downloads message elements (such as image, video, audio, and file) to a path |
| TIMMsgBatchSend | Sends a message to multiple users at a time, but not to groups |
Group APIs
| API | Description |
|---|---|
| TIMGroupCreate | Creates a group |
| TIMGroupDelete | Deletes a group |
| TIMGroupJoin | Requests to join a group |
| TIMGroupQuit | Quits a group |
| TIMGroupInviteMember | Invites someone to join a group |
| TIMGroupDeleteMember | Removes a member from a group |
| TIMGroupGetJoinedGroupList | Gets the list of groups that a user has joined |
| TIMGroupGetGroupInfoList | Gets group information |
| TIMGroupModifyGroupInfo | Modifies group information |
| TIMGroupGetMemberInfoList | Gets group member information |
| TIMGroupModifyMemberInfo | Modifies group member information |
| TIMGroupGetPendencyList | Gets the pending group request list. Pending group requests are those that are not handled, for example, requests to join a group or to invite a user to join a group. |
| TIMGroupReportPendencyReaded | Reports that a pending group request is read |
| TIMGroupHandlePendency | Handles pending group requests |
User Profile APIs
| API | Description |
|---|---|
| TIMProfileGetUserProfileList | Gets the profiles of specified users |
| TIMProfileModifySelfUserProfile | Modifies one's own profile |
Relationship Chain APIs
| API | Description |
|---|---|
| TIMFriendshipGetFriendProfileList | Gets friend lists |
| TIMFriendshipAddFriend | Adds friends |
| TIMFriendshipHandleFriendAddRequest | Handles friend requests |
| TIMFriendshipModifyFriendProfile | Updates friends' profiles (such as remarks) |
| TIMFriendshipDeleteFriend | Deletes friends |
| TIMFriendshipCheckFriendType | Checks the friend type (one-way or two-way) |
| TIMFriendshipCreateFriendGroup | Creates a friend list |
| TIMFriendshipGetFriendGroupList | Gets the information of a friend list |
| TIMFriendshipModifyFriendGroup | Modifies a friend list |
| TIMFriendshipDeleteFriendGroup | Deletes a friend list |
| TIMFriendshipAddToBlackList | Adds a user to the blocklist |
| TIMFriendshipGetBlackList | Gets the blocklist |
| TIMFriendshipDeleteFromBlackList | Removes a user from the blocklist |
| TIMFriendshipGetPendencyList | Gets the pending friend request list |
| TIMFriendshipDeletePendency | Deletes a pending friend request |
| TIMFriendshipReportPendencyReaded | Reports that a pending friend request is read |
Yes
No
Was this page helpful?