API | Description |
Initializes the SDK. | |
Uninitializes the SDK. | |
Add IM listener | |
Remove IM listener | |
Gets the version number. | |
Gets the server time. | |
Logs in. | |
Logs out. | |
Gets the currently logged-in user. | |
Gets the login status. | |
Gets user status information. | |
Sets user status for yourself. | |
Subscribes user status. | |
Unsubscribes user status. |
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. |
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). | |
modify invitation. |
API | Description |
Sets an event listener for advanced messages.Do not use it and addSimpleMsgListener at the same time. | |
Removes the listener for advanced messages. | |
Creates a text message. | |
Creates an @ text message. | |
Creates a custom message. | |
Creates an image message. | |
Creates a voice 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 | |
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. | |
Gets one-to-one (C2C) message history. | |
Gets group chat message history. | |
Gets message history. | |
Recalls a message. The message object can be created using a createXXXMessage API. | |
Modifies a message. The message object can be created using a createXXXMessage API. | |
Marks one-to-one (C2C) messages as read. | |
Marks group messages as read. | |
Marks all messages as read. | |
Deletes a message from 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. | |
Sends read receipts to the message sender for message which have been received. | |
Gets read receipts for messages which have been sent by myself. | |
Gets group members profile who have read ths message. | |
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. |
API | Description |
Adds an event listener for groups. | |
Removes event listener for groups. | |
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. | |
Quits a group. | |
Deletes 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 profiles of groups. | |
Searches for groups. | |
Modifies the profile of a group. | |
Initializes group attributes. | |
Sets group attributes. | |
Deletes group attributes. | |
Gets group attributes. | |
Gets the number of online group members. | |
Gets group member list. | |
Gets the profiles of specified group members. | |
Searches for group members. | |
Modifies the profile of a specified group member. | |
Mutes a group member. | |
Invites users to a group. | |
Removes a member from a group. | |
Sets the role for a group member. | |
Mark group member list . | |
Changes the group owner. | |
Gets the list of requests to join a group. | |
Accepts 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 that the current user has joined | |
Creates topic | |
Deletes topic | |
Modifies topic information | |
Gets topic list |
API | Description |
Adds a conversation listener. | |
Removes conversation listener. | |
Gets the conversation list. | |
Gets a conversation. | |
Gets multiple conversations. | |
Gets multiple conversations (advanced API). | |
Deletes a conversation. | |
Sets draft for a conversation. | |
Sets custom data for a conversation. | |
Pins a conversation to the top. | |
Marks a conversation to the top. | |
Gets the total unread message count. | |
Create conversation group. | |
Get conversation group list. | |
Delete conversation group. | |
Rename conversation group. | |
Add conversations to group. | |
Delete conversations from group. |
API | Description |
Gets users’ profiles. | |
Modifies one's own user profile. | |
Blocks messages from a specified user, which means adding the user to the blocklist. | |
Unblocks messages from a specified user, which means removing the user from the blocklist. | |
Gets the blocklist. |
API | Description |
Sets an APNs listener. | |
Configures APNS push. | |
Configures VOIP push. |
API | Description |
Adds a Contacts listener to receive friend list and blocklist change events. | |
Removes Contacts listener. | |
Gets the friend list. | |
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. | |
Deletes friends from a friend list. |
Was this page helpful?