tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Android

    Last updated: 2024-10-29 11:02:03
    Download PDF
      Caution
      Do not use APIs of new and old versions at the same time.

      Initialization and Login APIs

      To use the Tencent Cloud Chat service, you need to initialize the SDK and log in.
      API
      Description
      Initializes the SDK.
      Uninitializes the SDK.
      Adds the Chat listener.
      Removes the Chat listener.
      Gets the version number.
      Gets the server time.
      Logs in.
      Logs out.
      Gets the login status.
      Gets the UserID of the currently logged-in user.

      Simple Message APIs

      Use the following APIs for the sending and receiving of text and signaling (custom buffer) messages.
      API
      Description
      Sets an event listener for simple messages (text messages and custom messages). Do not use it and addAdvancedMsgListener at the same time.
      Removes the event listener for simple messages (text messages and custom messages).
      Sends a one-to-one (C2C) text message.
      Sends a one-to-one (C2C) custom (signaling) message.
      Sends a group text message.
      Sends a group custom (signaling) message.

      Signaling APIs

      API
      Description
      Adds a signaling listener.
      Removes a signaling listener.
      Invites a user.
      Invites certain users in the group.
      Cancels an invitation.
      Accepts an invitation.
      Rejects an invitation.
      Gets the signaling information.
      Adds invitation signaling (can be used for invitation signaling triggered by offline push messages for group invitations).
      Modifies the invitation signaling.

      Advanced Message APIs

      If you need to send/receive rich media messages (such as image, video, and file messages) and use advanced features such as recalling messages, marking messages as read, and querying message history, use the following set of advanced message APIs. Do not use simple message APIs and advanced message APIs at the same time.
      API
      Description
      Sets an event listener for advanced messages. Do not use it and addSimpleMsgListener at the same time.
      Removes the event listener for advanced messages.
      Creates a text message.
      Creates a custom message.
      Creates an image message.
      Creates an audio message.
      Creates a video message.
      Creates a file message.
      Creates a location message.
      Creates an emoji message.
      Creates a combined forward message.
      Creates a single forward message.
      Creates a targeted group message.
      Creates a group @ message.
      Sends a message. The message object can be created using a createXXXMessage API.
      Sets the Mute Notifications option for one-to-one messages.
      Gets the Mute Notifications status for one-to-one messages.
      Sets the Mute Notifications option for group messages.
      Sets the Mute Notifications status for global messages (daily repetition allowed).
      Sets the Mute Notifications status for global messages.
      Gets the Mute Notifications status for global messages.
      Gets one-to-one (C2C) message history.
      Gets the group message history.
      Gets message history.
      Recalls a message. The message object can be created using a createXXXMessage API.
      Modifies a message.
      Marks one-to-one (C2C) messages as read (a interface to be abandoned. Use the cleanConversationUnreadMessageCount interface).
      Marks group messages as read (a interface to be abandoned. Use the cleanConversationUnreadMessageCount interface).
      Marks all conversations as read (a interface to be abandoned. Use the cleanConversationUnreadMessageCount interface).
      Deletes a message from the local storage.
      Deletes messages from local storage and the cloud.
      Clears chat history with a user from local storage and the cloud.
      Clears chat history of a group from local storage and the cloud.
      Inserts a message in a group chat.
      Inserts a message in a one-to-one chat.
      Finds local messages by msgID.
      Searches for local messages.
      Searchs for cloud messages.
      Sends message read receipts.
      Gets message read receipts.
      Gets the list of group members who have read group messages.
      Sets message extensions.
      Gets message extensions.
      Deletes message extensions.
      Adds message reaction.
      Removes message reaction.
      Gets message reactions.
      Gets all user list of message reaction.
      Sets group message pinning.
      Gets pinned group message list.

      Group APIs

      Tencent Cloud Chat SDK supports five preset group types, each of which pertains to different scenarios.
      Work group (Work): users can join the group only after being invited by group members. This group type is the same as private group (Private) in earlier versions.
      Public group (Public): Users can join a public group through requests, which need to be approved by the group owner or group admin.
      Meeting group (Meeting): used together with TRTC to enable scenarios such as video conferencing and online education. Users can join and leave the group freely and view the message history before they join. Same as chat room (ChatRoom) in earlier versions.
      Community: A user can join and leave a community freely. It is suitable for chat scenarios with a super large number of community members, such as knowledge sharing and game discussion. This feature is supported by a client with the SDK enhanced edition v5.8.1668 or later and the web SDK v2.17.0 or later. To use it, you need to purchase the Premium edition, and then enable it in Console, path: Applications > Your App > Chat > Configuration > Group Configuration > Community.
      Audio-video group (AVChatRoom): An audio-video group allows users to join and leave freely and is suitable for scenarios such as live streaming and chat rooms with on-screen comments. There is no limit on the number of group members.
      API
      Description
      Adds a group listener.
      Removes a group listener.
      Creates a (simple) group
      Creates an (advanced) group. The group information and the initial group members can be set during group creation.
      Joins a group.
      Leaves a group.
      Disbands a group. Only the group owner and group admin can delete a group.
      Gets the list of groups the current user has joined, excluding audio-video groups.
      Pulls the profiles of groups.
      Searches for groups.
      Modifies a group profile.
      Initializes group attributes.
      Sets group attributes.
      Deletes group attributes.
      Gets group attributes.
      Gets the number of online group members.
      Sets group counters.
      Gets group counters.
      Increment group counters.
      Decrement group counters.
      Gets the group member list.
      Gets the profiles of specified group members.
      Searches for group members.
      Modifies the profile of a specified group member.
      Mutes group members.
      Mute all group members. Only administrators or group owners can call this function.
      Removes a member from a group.
      Sets the role of a group member.
      Marks group members.
      Transfers the group ownership.
      Invites users to a group.
      Gets the list of requests to join a group.
      Approves a request to join a group.
      Rejects a request to join a group.
      Marks the request list as read.
      Gets the list of community groups the current user has joined.
      Creates a topic.
      Deletes a topic.
      Modifies topic information.
      Gets the list of topics.

      Community Topic-Related APIs

      If you need to create topics under a community, please use this set of interfaces. Communities are used to manage group members, and all topics under a community can not only share community members but also send and receive messages independently without interfering with each other.
      API
      Description
      Adds a community listener.
      Removes a community listener.
      Creates a community with topic support.
      Gets the list of communities with topic support that the current user has joined.
      Creates a topic.
      Deletes a topic.
      Modifies topic information.
      Gets a topic list.
      Creates a community permission group.
      Deletes a community permission group.
      Modifies a community permission group.
      Gets the list of community permission groups the current user has joined.
      Gets the list of community permission groups.
      Adds members to a community permission group.
      Removes members from a community permission group.
      Gets the member list of a community permission group.
      Adds topic permissions to a permission group.
      Removes topic permissions from a permission group.
      Modifies topic permissions in a permission group.
      Gets topic permissions in a permission group.

      Conversation List APIs

      The conversation list is the list a user sees on the first screen after login. It includes elements such as conversation node, conversation name, group name, last message, and unread count.
      API
      Description
      Adds a conversation listener.
      Removes a conversation listener.
      Gets the conversation list.
      Gets the advanced conversation API to specify the conversation type, mark type, and group name.
      Gets a conversation.
      Gets multiple conversations.
      Deletes a conversation.
      Deletes a conversation list.
      Sets a draft for a conversation.
      Sets custom conversation data.
      Pins a conversation to the top.
      Marks a conversation.
      Gets the total unread message count.
      Gets the total number of unread messages filtered by conversation.
      Registers a listener for changes in the total number of unread messages in a specific conversation.
      Unregisters a listener for changes in the total number of unread messages in a specific conversation.
      Clears the unread message count for a conversation.
      Creates a conversation group.
      Gets the list of conversation groups.
      Deletes a conversation group.
      Renames a conversation group.
      Adds a conversation to a conversation group.
      Deletes a conversation from a conversation group.

      User Profile APIs

      You can use the following APIs to query user profiles, modify your profile, and block messages from a specified user (that is, adding a specified user to the blocklist).
      API
      Description
      Gets user profiles.
      Modifies one's own user profile.
      Subscribe to user profile.
      Unsubscribe from user profile.
      Queries a user's status.
      Sets one's own status.
      Subscribes to a user's status.
      Unsubscribes from a user's status.
      Blocks messages from a user, which means adding the user to the blocklist.
      Unblocks messages from a user, which means removing the user from the blocklist.
      Gets the blocklist.

      Offline Push APIs

      We recommend you use the offline push service if you want your app to receive Chat service messages in real time when it runs in the background. As there is no unified push service in the Chinese mainland, you need to configure Android offline push for devices of different vendors separately.
      API
      Description
      Configures offline push.
      The APP can call this interface when it detects that the application has entered the background, which can be used to initialize the unread count for the desktop application badge.
      The APP can call this interface when it detects that the application has entered the foreground.

      Friend Management APIs

      Tencent Cloud Chat SDK does not check friend relationships by default when sending and receiving messages. To achieve the interactive experience of "add friends first, then send messages", you can log in to the Console to modify Relationship Check. When enabled, users can only send messages to their friends. When a user sends a message to a non-friend, SDK will report a 20009 error code. The configuration path is: Applications > Your App > Chat > Configuration > Login and Message > Relationship Check.
      Use the following API to add or delete friends and manage friend lists.
      API
      Description
      Adds a contacts listener.
      Removes a contacts listener.
      Gets the contacts.
      Gets the profiles of specified friends.
      Sets the profile of a specified friend.
      Searches for friends.
      Adds a friend.
      Deletes a friend.
      Checks relationship with specified users.
      Gets the list of friend requests.
      Accepts a friend request.
      Rejects a friend request.
      Deletes a friend request.
      Marks a friend request as read.
      Creates a friend list.
      Gets the information of friend lists.
      Deletes friend lists.
      Modifies the name of a friend list.
      Adds friends to a friend list.
      Removes friends from a friend list.
      Subscribes to official accounts.
      Unsubscribes from official accounts.
      Gets the list of official accounts.
      Follows users.
      Unfollows users.
      Gets my follow list.
      Gets my fan list.
      Gets my mutual follow list.
      Gets the follow/fan/mutual follow count information for a specified user.
      Checks the follow type of a specified user.
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy