Docs Overview/
Unity/

Unity

Note
For API details, see here.

Conversation APIs

API
Description
Cancels a draft of a conversation.
Deletes a conversation.
Gets the information of conversations.
Gets the conversation list.
Gets the total unread count of all conversations.
Pins a conversation to the top.
Sets a draft for a conversation.

Relationship Chain APIs

API
Description
Adds a friend.
Adds a user to the blocklist.
Checks the friend type.
Creates a friend list.
Deletes a friend.
Deletes a friend list.
Removes a user from the blocklist.
Deletes a pending friend request.
Gets the blocklist.
Gets the information of a friend list.
Gets the profiles of all friends.
Gets the information of friends.
Gets the list of pending group requests.
Handles a friend request.
Modifies a friend list.
Modifies the profile of a friend.
Reports that a pending friend request is read.
Searches for friends.

Group APIs

API
Description
Creates a group.
Creates a topic.
Disbands a group.
Deletes custom group attributes.
Deletes a group member.
Deletes a topic.
Gets group attributes.
Gets group information.
Gets the list of community groups the current user has joined.
Gets the list of groups that a user has joined.
Gets group member information.
Gets the number of online group members.
Gets the list of pending group requests.
Gets the list of topics.
Handles pending group requests.
Initializes custom group attributes.
Invites a user to join a group.
Joins a group.
Modifies group information.
Modifies group member information.
Leaves a group.
Reports that a pending group request is read.
Searches for group members.
Searches for group profiles.
Sets group attributes.
Modifies topic information.

Chat SDK Initialization APIs

API
Description
Gets the version of the underlying library of the Chat SDK.
Gets the server time (seconds).
Initializes the Chat SDK.
Sets global configuration.
Uninitializes the Chat SDK.

Login APIs

API
Description
Gets the current login status.
Gets the ID of the current login user.
Logs in.
Logs out.

Message APIs

API
Description
Gets the list of members who have read the group message.
Sends a message to multiple users at a time.
Cancels the sending of a message.
Clears historical messages.
Deletes the messages of a conversation.
This API can be called when the app detects that the app switches to the background.
This API can be called when the app detects that the app switches to the foreground.
Downloads a multimedia message.
Downloads a combined message.
Locates a message by using a message locator.
Locates local messages.
Gets the message receiving option for a one-to-one chat.
Gets message read receipts.
Gets the historical message list of a conversation.
Imports messages.
Deletes messages.
Marks all messages as read.
Modifies a message.
Reports that a one-to-one message is read.
Recalls a message.
Saves a message.
Searches for local messages.
Sends a message.
Sends message read receipts.
Sets the one-to-one message receiving option.
Sets the group message receiving option.
Sets local message data.
Sets offline push configuration.

User Profile APIs

API
Description
Queries a user's status.
Gets the profiles of specified users.
Modifies one's own profile.
Sets one's own status.
Subscribes to a user's status.
Unsubscribes from a user's status.

SDK Callback Registration APIs

API
Description
Adds the callback for receiving new messages.
Removes the callback for receiving new messages.
Sets the callback for conversation events.
Sets the callback for a change in the total unread message count of conversations.
Sets the callback for friend requests.
Sets the callback for deleting a friend request.
Sets the callback for reading a friend request.
Sets the callback for adding a friend to the blocklist.
Sets the callback for removing a friend from the blocklist.
Sets the callback for a group attribute change.
Sets the callback for group system messages.
Sets the callback for topic updates.
Sets the callback for topic creation.
Sets the callback for topic deletion.
Sets the callback for notifications of forced logout.
Sets the callback for logs.
Sets the callback for the upload progress of message element files.
Sets the callback for message read receipts.
Sets the callback for message recalls.
Sets the callback for message update notifications returned after messages are modified in the cloud.
Sets the callback for network connection status.
Sets the callback for adding friends.
Sets the callback for deleting friends.
Sets the callback for deleting friends.
Sets the callback for updating the current user's profile.
Sets the callback for updating friends' profiles.
Sets the callback for user ticket expiration.
Sets the callback for user status update notifications.