Note：
Do not use new and old API versions at the same time.
To use Tencent Cloud IM services, you need to initialize and log in.
| API | Description |
|---|---|
| initSDK | Initializes the SDK. |
| unInitSDK | Uninitializes the SDK. |
| login | Logs a user in. |
| logout | Logs a user out. |
| getLoginStatus | Gets the login status. |
| getLoginUser | Gets the UserID of the current login user. |
Use the following message APIs if you only need to use text and signaling (a piece of custom buffer) messages.
| API | Description |
|---|---|
| addSimpleMsgListener | Sets an event listener for simple messages (text messages and custom messages). Do not use it with addAdvancedMsgListener. |
| removeSimpleMsgListener | Removes the event listener for simple messages (text messages and custom messages). |
| sendC2CTextMessage | Sends a one-to-one chat (C2C) text message. |
| sendC2CCustomMessage | Sends a one-to-one chat (C2C) custom (signaling) message. |
| sendGroupTextMessage | Sends a group chat text message. |
| sendGroupCustomMessage | Sends a group chat custom (signaling) message. |
| API | Description |
|---|---|
| addSignalingListener | Adds a signaling listener. |
| removeSignalingListener | Removes a signaling listener. |
| invite | Invites a user. |
| inviteInGroup | Invites certain users in the group. |
| cancel | The inviter cancels the invitation. |
| accept | The invitee accepts the invitation. |
| reject | The invitee rejects the invitation. |
| getSignalingInfo | Obtains signaling information. |
| addInvitedSignaling | Adds invitation signaling (can be used for invitation signaling triggered by group offline push messages). |
If you need rich media messages (images, video, files, etc.) and advanced features such as receiving and sending messages, recalling messages, marking messages as read, and querying message history, use the following set of advanced message APIs. Do not use a mixture of simple messages APIs and advanced message APIs.
| API | Description |
|---|---|
| addAdvancedMsgListener | Sets an event listener for advanced messages. Do not use it with addSimpleMsgListener. |
| removeAdvancedMsgListener | Removes the listener for advanced messages. |
| createTextMessage | Creates a text message. |
| createCustomMessage | Creates a custom message. |
| createImageMessage | Creates an image message. |
| createSoundMessage | Creates a voice message. |
| createVideoMessage | Creates a video message. |
| createFileMessage | Creates a file message |
| createLocationMessage | Creates a location message. |
| createFaceMessage | Creates an emoji message. |
| sendMessage | Sends a message. The message object can be created from the createXXXMessage API. |
| revokeMessage | Recalls a message. The message object can be created from the createXXXMessage API. |
| getC2CHistoryMessageList | Gets one-to-one chat (C2C) message history. |
| getGroupHistoryMessageList | Gets group message history. |
| markC2CMessageAsRead | Marks one-to-one chat (C2C) messages as read. |
| markGroupMessageAsRead | Marks group messages as read. |
| deleteMessageFromLocalStorage | Deletes a message from local storage. |
| insertGroupMessageToLocalStorage | Adds a message to group message list. |
Tencent Cloud IM SDK supports four predefined group types, each pertaining to different application scenarios.
| API | Description |
|---|---|
| setGroupListener | Set an event listener for groups. |
| createGroup | Creates a group (simple). |
| createGroup | Creates a group (advanced). Group information and initial group members can be set during group creation. |
| joinGroup | Joins a group. |
| quitGroup | Quits a group. |
| dismissGroup | Disbands a group. Only the group owner and group admin can disband the group. |
| getJoinedGroupList | Gets the list of groups the current user has joined, excluding live-streaming groups. |
| getGroupsInfo | Pulls profiles of groups. |
| setGroupInfo | Modifies the profile of a group. |
| setReceiveMessageOpt | Sets the group message receiving option. |
| getGroupMemberList | Gets group member list. |
| getGroupMembersInfo | Gets the profiles of specified group members. |
| setGroupMemberInfo | Modifies the profile of a specified group member. |
| muteGroupMember | Mutes a group member. |
| kickGroupMember | Kicks members out of a group. |
| setGroupMemberRole | Sets the role for a group member. |
| transferGroupOwner | Transfers the ownership of a group. |
| inviteUserToGroup | Invites users to a group. |
| getGroupApplicationList | Gets the list of applications to join a group. |
| acceptGroupApplication | Approves an application to join group. |
| refuseGroupApplication | Rejects an application to join group. |
| setGroupApplicationRead | Marks application list as read. |
Conversation list is the list a user sees on the first screen after logging in to WeChat or QQ. It includes elements such as conversation node, conversation name, group name, last message, and unread count.
| API | Description |
|---|---|
| setConversationListener | Sets a conversation listener. |
| getConversationList | Gets the conversation list. |
| deleteConversation | Deletes a conversation. |
| setConversationDraft | Sets draft for a conversation. |
APIs to query user profiles, modify the user profile of oneself, and block messages from a specified user (or add a specified user to blacklist).
| API | Description |
|---|---|
| getUsersInfo | Gets users’ profiles. |
| setSelfInfo | Modifies the user profile of oneself. |
| addToBlackList | Blocks the messages from a specified user, which means to add the user to blacklist. |
| deleteFromBlackList | Unblocks the messages from a specified user, which means to remove the user from blacklist. |
| getBlackList | Gets the blacklist. |
Use the offline push service if you want your app to receive IM messages in real time when it is in the background. As there is currently no unified push service in mainland China, to implement Android offline push, mobile phones of different vendors need to be specifically adapted.
| API | Description |
|---|---|
| setOfflinePushConfig | Sets the offline push configuration. |
By default, Tencent Cloud IM does not check for the relationship when receiving and sending messages. You can turn on the "Check Relationship for One-to-One Chat Messages" toggle from Console > Feature Configuration > Login and Message > Relationship Check and use the following APIs to delete/add friends and manage friend list.
| API | Description |
|---|---|
| setFriendListener | Sets a relationship chain listener to receive friend list and blacklist change events. |
| getFriendList | Gets the friend list. |
| getFriendsInfo | Gets the profiles of specified friends. |
| setFriendInfo | Sets the profile of a specified friend. |
| addFriend | Adds a friend. |
| deleteFromFriendList | Deletes a friend. |
| checkFriend | Checks the relationship with a specified user. |
| getFriendApplicationList | Gets the list of friend requests. |
| acceptFriendApplication | Accepts a friend request. |
| refuseFriendApplication | Rejects a friend request. |
| deleteFriendApplication | Deletes a friend request. |
| setFriendApplicationRead | Sets a friend request as read. |
| createFriendGroup | Creates a friend list. |
| getFriendGroups | Gets the information of friend lists. |
| deleteFriendGroup | Deletes friend lists. |
| renameFriendGroup | Modifies the name of a group list. |
| addFriendsToFriendGroup | Adds friends to a friend list. |
| deleteFriendsFromFriendGroup | Deletes friends from a friend list. |
Was this page helpful?