| User Information |
register |
Register and obtain token |
3.0.1 |
|
update |
Update user information |
3.0.1 |
|
get |
Query user information |
3.0.8 |
|
getGroups |
Query groups the user belongs to |
3.2.3 |
|
expire |
Token invalidation |
3.2.11 |
|
deactivate |
User deactivation |
3.3.2 |
|
reactivate |
Reactivate user ID |
3.3.5 |
|
deactivateList |
Query deactivated users |
3.3.2 |
|
querySandBoxUsers |
Query development environment user list |
4.0.8 |
|
deleteSandBoxUsers |
Delete development environment users |
4.0.8 |
| Check User Online Status |
onlinestatus.check |
Check user online status |
3.0.1 |
| Blocklist |
blacklist.add |
Add to blocklist |
3.0.1 |
|
blacklist.getList |
Get blocklist |
3.0.1 |
|
blacklist.pagingQueryBlacklist |
Paginate blocklist |
3.6.2 |
|
blacklist.remove |
Remove from blocklist |
3.0.1 |
| Allowlist |
whitelist.add |
Add to allowlist |
3.0.7 |
|
whitelist.getList |
Get allowlist |
3.0.7 |
|
whitelist.pagingQueryWhitelist |
Paginate allowlist |
3.6.2 |
|
whitelist.remove |
Remove from allowlist |
3.0.7 |
| User Block |
block.add |
Block user |
3.0.1 |
|
block.getList |
Get blocklist |
3.0.1 |
|
block.remove |
Unblock user |
3.0.1 |
| User Tags |
tag.set |
Add user tags |
|
|
tag.batchset |
Batch add user tags |
3.0.4 |
|
tag.get |
Get user tags |
3.0.4 |
| User One-to-One Chat Mute |
ban.set |
Add user tags |
3.2.11 |
|
ban.getList |
Get user tags |
3.2.11 |
| User Global Group Mute |
muteGroups.add |
Add global group mute user, after adding, the user cannot send messages in all groups under the application |
3.0.2 |
|
muteGroups.remove |
Remove global group mute user |
3.0.2 |
|
muteGroups.getList |
Get global group mute user list |
3.0.2 |
| User Global Chatroom Mute |
muteChatrooms.add |
Add global chatroom mute user, after adding, the user cannot send messages in all chatrooms under the application |
3.0.2 |
|
muteChatrooms.remove |
Remove global chatroom mute user |
3.0.2 |
|
muteChatrooms.getList |
Get global chatroom mute user list |
3.0.2 |
| Sensitive Words |
add |
Add sensitive words, which take effect by default after 30 minutes |
3.0.1 |
|
batchAdd |
Batch add sensitive words, which take effect by default after 30 minutes |
3.4.0 |
|
getList |
Get sensitive word list |
3.0.1 |
|
remove |
Remove sensitive words, supports batch removal, which takes effect by default after 2 hours |
3.0.1 |
| Message Sending |
private.send |
Send one-to-one chat message |
3.0.1 |
|
private.sendTemplate |
Send one-to-one chat template message |
3.0.1 |
|
private.recall |
Recall one-to-one chat message |
3.0.1 |
|
chatroom.send |
Send chatroom message |
3.0.1 |
|
chatroom.recall |
Recall chatroom message |
3.0.7 |
|
chatroom.broadcast |
Send chatroom broadcast message |
3.0.1 |
|
group.send |
Send group message |
3.0.1 |
|
group.sendMention |
Send group @ message |
3.1.6 |
|
group.recall |
Recall group message |
3.0.1 |
|
system.send |
Send system message |
3.0.1 |
|
system.sendTemplate |
Send system template message |
3.0.1 |
|
system.broadcast |
Send broadcast message, each application can only send 2 times per hour and up to 3 times per day. |
3.0.1 |
|
system.onlineBroadcast |
Broadcast to online users |
3.2.11 |
|
system.recallBroadcast |
Recall all landing notifications |
3.2.11 |
|
Private.sendStatusMessage |
Support sending one-to-one chat status message |
3.1.7 |
|
group.sendStatusMessage |
Support sending group chat status message |
3.1.7 |
|
Private.sendTypingStatusMessage |
Support sending typing status message, only for one-to-one chat text messages |
3.1.7 |
|
Private.send(InfoNtfMessage) |
Support sending gray bar message (received by all group members, specified group members, or one-to-one chat gray bar message) |
3.1.8 |
|
Private.send(ReadReceiptMessage) |
Support sending one-to-one chat read receipt message, with configurable conversation type |
3.1.8 |
|
Private.send - SightMessage |
Support sending short video type message |
3.1.10 |
|
Private.send - FileMessage |
Support sending file type message |
3.1.10 |
| Message History |
message.history.get |
Get message history download URL |
3.0.1 |
|
message.history.remove |
Delete message history |
3.0.1 |
|
message.history.queryPrivateHistoryMessage |
Query the history message of one-to-one chat |
3.9.0 |
|
message.history.queryGroupHistoryMessage |
Query the history message of group chat |
4.0.0 |
|
message.history.queryUltraGroupHistoryMessage |
Query the history message of ultra group chat |
4.0.0 |
|
message.history.queryChatroomHistoryMessage |
Query the history message of chatroom |
4.0.0 |
| Broadcast Push |
Push.push |
Send push notification, combined with broadcast messages, each application can only send 2 times per hour and up to 3 times per day. |
3.0.4 |
|
Push.message |
Send broadcast message, combined with push notifications, each application can only send 2 times per hour and up to 3 times per day. |
3.0.4 |
| Group |
create |
Create group |
3.0.1 |
|
sync |
Sync group relationships |
3.0.1 |
|
update |
Update group information |
3.0.1 |
|
get |
Get group information |
3.0.1 |
|
invite |
Invite users to join group |
3.0.1 |
|
quit |
Quit group |
3.0.1 |
|
dismiss |
Dismiss group |
3.0.1 |
| User Specified Group Mute |
muteMembers.add |
Add specified group mute user, the user cannot send messages in the specified group |
3.0.2 |
|
muteMembers.remove |
Remove specified group mute user |
3.0.2 |
|
muteMembers.getList |
Get specified group mute user list |
3.0.2 |
| Specified Group All Members Mute |
muteAllMembers.add |
Add specified group all members mute, after adding, all users in the group cannot send messages in this group |
3.0.2 |
|
muteAllMembers.remove |
Remove specified group all members mute |
3.0.2 |
|
muteAllMembers.getList |
Get group mute list |
3.0.2 |
| Group Mute Allowlist |
muteWhiteList.user.add |
Add group mute allowlist user, after the group is muted, users in the allowlist can send messages in the group |
3.0.2 |
|
muteWhiteList.user.remove |
Remove group mute allowlist user |
3.0.2 |
|
muteWhiteList.user.getList |
Get group mute allowlist user list |
3.0.2 |
| Conversation |
mute |
Add do not disturb conversation |
3.0.1 |
|
unMute |
Remove do not disturb conversation |
3.0.1 |
|
get |
Get do not disturb conversation status |
3.0.1 |
|
setTop |
Pin conversation |
3.7.0 |
| Chatroom |
create |
Create chatroom |
3.0.1 |
|
destroy |
Destroy chatroom |
3.0.1 |
|
get |
Query chatroom information |
3.0.1 |
|
isExist |
Check if user is in chatroom |
3.0.1 |
|
createV2 |
Create chatroom method V2 |
3.3.3 |
|
setDestroyType |
Set chatroom destruction type |
3.3.3 |
|
query |
Query chatroom information |
3.3.3 |
| Chatroom Block |
block.add |
Add chatroom block user, after blocking, the user cannot join the chatroom, and if the user is in the chatroom, they will be kicked out |
3.0.1 |
|
block.getList |
Get chatroom block user list |
3.0.1 |
|
block.remove |
Remove chatroom block user |
3.0.1 |
| Chatroom Mute |
muteMembers.add |
Add chatroom mute user, the user cannot send messages in the chatroom |
3.0.2 |
|
muteMembers.getList |
Get chatroom mute user list |
3.0.2 |
|
muteMembers.remove |
Remove chatroom mute user |
3.0.2 |
| Chatroom Message Priority |
demotion.add |
Add chatroom low priority message, after adding, when server pressure is high due to a surge in messages, low priority messages will be discarded by default |
3.0.1 |
|
demotion.getList |
Query chatroom low priority message list |
3.0.1 |
|
demotion.remove |
Remove chatroom low priority message |
3.0.1 |
| Chatroom Message Distribution Control |
distribute.stop |
Stop chatroom message distribution, the server will not send downstream messages after receiving upstream messages |
3.0.1 |
|
distribute.resume |
Resume chatroom message distribution |
3.0.1 |
| Chatroom Keepalive |
keepalive.add |
Add keepalive chatroom, keepalive chatrooms will not be automatically destroyed |
3.0.1 |
|
keepalive.remove |
Remove keepalive chatroom |
3.0.1 |
|
keepalive.getList |
Get keepalive chatroom list |
3.0.1 |
| Chatroom Message Allowlist |
whiteList.message.add |
Add allowlist message type, message types in the allowlist will not be discarded when server pressure is high due to a surge in messages, ensuring message delivery |
3.0.1 |
|
whiteList.message.remove |
Remove allowlist message type |
3.0.1 |
|
whiteList.message.getList |
Get allowlist message type list |
3.0.1 |
| Chatroom User Allowlist |
whiteList.user.add |
Add allowlist user, messages sent by users in the allowlist will not be discarded when server pressure is high due to a surge in messages, ensuring message delivery |
3.0.1 |
|
whiteList.user.remove |
Remove allowlist user |
3.0.1 |
|
whiteList.user.getList |
Get allowlist user list |
3.0.1 |
| Chatroom Attribute Setting |
ChatroomEntry.set |
Set chatroom attributes |
3.1.9 |
|
ChatroomEntry.remove |
Delete chatroom attributes |
3.1.9 |
|
ChatroomEntry.query |
Query chatroom attributes |
3.1.9 |
|
ChatroomEntry.batchSet |
Batch set chatroom attributes (KV) |
3.3.3 |
| Chatroom All Members Mute |
BanAllMember.add |
Set all members mute in a chatroom, after setting, all members in the chatroom cannot send messages through the terminal SDK. |
3.2.8 |
|
BanAllMember.remove |
Remove all members mute |
3.2.8 |
|
BanAllMember.check |
Check mute status |
3.2.8 |
|
BanAllMember.getList |
Get mute list |
3.2.8 |
| Chatroom All Members Mute Allowlist |
BanAllMemberWhitelist.add |
After adding a user to the allowlist, if the user is muted in the chatroom, the allowlist permission takes precedence over the chatroom member mute, allowing the user to send messages. |
3.2.8 |
|
BanAllMemberWhitelist.remove |
Remove all members mute |
3.2.8 |
|
BanAllMemberWhitelist.getList |
Get mute list |
3.2.8 |
| Message Extension |
Expansion.add |
Set message extension, when sending a message, if expansion is set to true, you can set extended information for the message, up to 100 extended attributes can be set each time, |
|
|
system.broadcast |
Send broadcast messages. Each application can send a maximum of 2 times per hour and 3 times per day. |
3.0.1 |
|
system.onlineBroadcast |
Broadcast to online users |
3.2.11 |
|
system.recallBroadcast |
Recall broadcast messages with full delivery notification |
3.2.11 |
|
Private.sendStatusMessage |
Supports sending one-to-one chat status messages |
3.1.7 |
|
group.sendStatusMessage |
Supports sending group chat status messages |
3.1.7 |
|
Private.sendTypingStatusMessage |
Supports sending typing status messages, only for one-to-one text messages |
3.1.7 |
|
Private.send(InfoNtfMessage) |
Supports sending gray bar messages (received by all group members, specified group users, and one-to-one gray bar messages) |
3.1.8 |
|
Private.send(ReadReceiptMessage) |
Supports sending one-to-one read receipt messages, with configurable conversation types |
3.1.8 |
|
Private.send - SightMessage |
Supports sending short video type messages |
3.1.10 |
|
Private.send - FileMessage |
Supports sending file type messages |
3.1.10 |
| Message History |
message.history.get |
Get the download URL for message history records |
3.0.1 |
|
message.history.remove |
Method to delete message history records |
3.0.1 |
| Broadcast Push |
Push.push |
Send push notifications. Combined with broadcast messages, each application can send a maximum of 2 times per hour and 3 times per day. |
3.0.4 |
|
Push.message |
Send broadcast messages. Combined with push notifications, each application can send a maximum of 2 times per hour and 3 times per day. |
3.0.4 |
| Group |
create |
Create a group |
3.0.1 |
|
sync |
Synchronize group relationships |
3.0.1 |
|
update |
Update group information |
3.0.1 |
|
get |
Get group information |
3.0.1 |
|
invite |
Invite users to join a group |
3.0.1 |
|
quit |
Quit a group |
3.0.1 |
|
dismiss |
Dismiss a group |
3.0.1 |
| User-Specific Group Mute |
muteMembers.add |
Add a user to the mute list for a specific group. The user cannot send messages in the specified group. |
3.0.2 |
|
muteMembers.remove |
Remove a user from the mute list for a specific group |
3.0.2 |
|
muteMembers.getList |
Get the list of muted users for a specific group |
3.0.2 |
| All Members Mute in Specific Group |
muteAllMembers.add |
Mute all members in a specific group. After adding, all users in the group cannot send messages in the group. |
3.0.2 |
|
muteAllMembers.remove |
Remove the mute for all members in a specific group |
3.0.2 |
|
muteAllMembers.getList |
Get the list of muted groups |
3.0.2 |
| Group Mute Allowlist |
muteWhiteList.user.add |
Add a user to the allowlist for a muted group. After the group is muted, users in the allowlist can send messages in the group. |
3.0.2 |
|
muteWhiteList.user.remove |
Remove a user from the allowlist for a muted group |
3.0.2 |
|
muteWhiteList.user.getList |
Get the list of users in the allowlist for a muted group |
3.0.2 |
| Conversation |
mute |
Add a Do Not Disturb conversation |
3.0.1 |
|
unMute |
Remove a Do Not Disturb conversation |
3.0.1 |
|
get |
Get the status of a Do Not Disturb conversation |
3.0.1 |
|
setTop |
Pin a conversation |
3.7.0 |
| Chatroom |
create |
Create a chatroom |
3.0.1 |
|
destroy |
Destroy a chatroom |
3.0.1 |
|
get |
Query chatroom information |
3.0.1 |
|
isExist |
Check if a user is in a chatroom |
3.0.1 |
|
createV2 |
Create a chatroom method V2 |
3.3.3 |
|
setDestroyType |
Set the destruction type for a chatroom |
3.3.3 |
|
query |
Query chatroom information |
3.3.3 |
| Chatroom Block |
block.add |
Add a user to the blocklist for a chatroom. After being blocked, the user cannot join the chatroom. If the user is already in the chatroom, they will be kicked out. |
3.0.1 |
|
block.getList |
Get the list of blocked users for a chatroom |
3.0.1 |
|
block.remove |
Remove a user from the blocklist for a chatroom |
3.0.1 |
| Chatroom Mute |
muteMembers.add |
Add a user to the mute list for a chatroom. The user cannot send messages in the chatroom. |
3.0.2 |
|
muteMembers.getList |
Get the list of muted users for a chatroom |
3.0.2 |
|
muteMembers.remove |
Remove a user from the mute list for a chatroom |
3.0.2 |
| Chatroom Message Priority |
demotion.add |
Add low-priority messages for a chatroom. When server pressure increases due to a surge in messages, low-priority messages will be discarded by default. |
3.0.1 |
|
demotion.getList |
Query the list of low-priority messages for a chatroom |
3.0.1 |
|
demotion.remove |
Remove low-priority messages for a chatroom |
3.0.1 |
| Chatroom Message Distribution Control |
distribute.stop |
Stops chatroom message distribution. The server will not send downstream messages after receiving upstream messages. |
3.0.1 |
|
distribute.resume |
Resumes chatroom message distribution. |
3.0.1 |
| Chatroom Keepalive |
keepalive.add |
Adds a keepalive chatroom. Keepalive chatrooms will not be automatically destroyed. |
3.0.1 |
|
keepalive.remove |
Removes a keepalive chatroom. |
3.0.1 |
|
keepalive.getList |
Retrieves the list of keepalive chatrooms. |
3.0.1 |
| Chatroom Message Allowlist |
whiteList.message.add |
Adds a message type to the allowlist. Message types in the allowlist will not be discarded even under high server load, ensuring message delivery. |
3.0.1 |
|
whiteList.message.remove |
Removes a message type from the allowlist. |
3.0.1 |
|
whiteList.message.getList |
Retrieves the list of message types in the allowlist. |
3.0.1 |
| Chatroom User Allowlist |
whiteList.user.add |
Adds a user to the allowlist. Messages sent by users in the allowlist will not be discarded even under high server load, ensuring message delivery. |
3.0.1 |
|
whiteList.user.remove |
Removes a user from the allowlist. |
3.0.1 |
|
whiteList.user.getList |
Retrieves the list of users in the allowlist. |
3.0.1 |
| Chatroom Attribute Settings |
ChatroomEntry.set |
Sets chatroom attributes. |
3.1.9 |
|
ChatroomEntry.remove |
Deletes chatroom attributes. |
3.1.9 |
|
ChatroomEntry.query |
Queries chatroom attributes. |
3.1.9 |
|
ChatroomEntry.batchSet |
Batch sets chatroom attributes (KV). |
3.3.3 |
| Chatroom Mute All Members |
BanAllMember.add |
Mutes all members in a chatroom. After setting, all members in the chatroom cannot send messages via the SDK. |
3.2.8 |
|
BanAllMember.remove |
Removes the mute for all members. |
3.2.8 |
|
BanAllMember.check |
Checks the mute status. |
3.2.8 |
|
BanAllMember.getList |
Retrieves the list of muted members. |
3.2.8 |
| Chatroom Mute All Members Allowlist |
BanAllMemberWhitelist.add |
Adds a user to the allowlist. If the user is muted in the chatroom, the allowlist permission overrides the chatroom mute, allowing the user to send messages. |
3.2.8 |
|
BanAllMemberWhitelist.remove |
Removes the mute for all members. |
3.2.8 |
|
BanAllMemberWhitelist.getList |
Retrieves the list of muted members. |
3.2.8 |
| Message Expansion |
Expansion.add |
Sets message expansion. When sending a message, if expansion is set to true, up to 100 expansion attributes can be set, with a maximum of 300. |
3.2.15 |
|
Expansion.remove |
Deletes message expansion. |
3.2.15 |
|
Expansion.getList |
Retrieves expansion information. |
3.2.15 |
| User Profile Hosting |
ExternalUser.setProfile |
Sets user profile hosting information. |
3.6.0 |
|
ExternalUser.batchQueryUserProfiles |
Batch queries user profiles. |
3.6.0 |
|
ExternalUser.cleanProfile |
Clears user profile hosting information. |
3.6.0 |
|
ExternalUser.pagingQueryUserProfiles |
Batch queries user profiles. |
3.6.0 |
| Group Information Hosting |
EntrustGroup.create |
Creates a hosted group. |
3.6.0 |
|
EntrustGroup.updateProfile |
Sets group profile information. |
3.6.0 |
|
EntrustGroup.queryProfiles |
Batch retrieves group profile information. |
3.6.0 |
|
EntrustGroup.quit |
Exits a group. |
3.6.0 |
|
EntrustGroup.kickOut |
Kicks a user out of a group. |
3.6.0 |
|
EntrustGroup.kickOutAllGroups |
Kicks a user out of all groups. |
3.6.0 |
|
EntrustGroup.dismiss |
Dismisses a group. |
3.6.0 |
|
EntrustGroup.join |
Joins a group. |
3.6.0 |
|
EntrustGroup.transferOwner |
Transfers group ownership. |
3.6.0 |
|
EntrustGroup.importGroup |
Imports a hosted group. |
3.6.0 |
|
EntrustGroup.addManagers |
Sets group administrators. |
3.6.0 |
|
EntrustGroup.removeManagers |
Removes group administrators. |
3.6.0 |
|
EntrustGroup.pagingQueryMembers |
Retrieves group member information by pagination. |
3.6.0 |
|
EntrustGroup.queryMembersByUserIds |
Retrieves information for specified group members. |
3.6.0 |
|
EntrustGroup.setMemberInfo |
Sets group member profile information. |
3.6.0 |
|
EntrustGroup.setRemarkName |
Sets a remark name for a user in a specified group. |
3.6.0 |
|
EntrustGroup.delRemarkName |
Deletes a remark name for a user in a specified group. |
3.6.0 |
|
EntrustGroup.queryRemarkName |
Queries a remark name for a user in a specified group. |
3.6.0 |
|
EntrustGroup.followMember |
Sets a user as a specially followed member in a specified group. |
3.6.0 |
|
EntrustGroup.unfollowMember |
Removes a specially followed member in a specified group. |
3.6.0 |
|
EntrustGroup.getFollowedMember |
Retrieves the list of specially followed members in a specified group. |
3.6.0 |
|
EntrustGroup.pagingQueryGroups |
Paginate and query groups under the application |
3.6.0 |
|
EntrustGroup.pagingQueryJoinedGroups |
Paginate and query groups the user has joined |
3.6.0 |
| Friend |
Friend.add |
Add a friend |
3.6.0 |
|
Friend.delete |
Remove a friend |
3.6.0 |
|
Friend.clean |
Clear the friend relationship for a specified user |
3.6.0 |
|
Friend.setProfile |
Set friend profile information |
3.6.0 |
|
Friend.pagingGetFriends |
Get the user's friend list |
3.6.0 |
|
Friend.checkFriends |
Check the friend relationship between users |
3.6.0 |
|
Friend.setPermission |
Set friend request permissions |
3.6.0 |
|
Friend.getPermission |
Get friend request permissions |
3.6.0 |
| Chatbot |
Chatbot.create |
Create a chatbot |
4.0.5 |
|
Chatbot.get |
Get a chatbot |
4.0.5 |
|
Chatbot.update |
Update a chatbot |
4.0.5 |
|
Chatbot.delete |
Delete a chatbot |
4.0.5 |
|
Chatbot.query |
Query chatbots |
4.0.5 |
|
Chatbot.createIntegration |
Create integration for chatbot |
4.0.5 |
|
Chatbot.deleteIntegration |
Delete integration for chatbot |
4.0.5 |
|
Chatbot.updateIntegration |
Update integration for chatbot |
4.0.5 |
| AI agent |
AIAgent.create |
Create a AI agent |
4.0.5 |
|
AIAgent.get |
Get a AI agent |
4.0.5 |
|
AIAgent.delete |
Delete a AI agent |
4.0.5 |
|
AIAgent.update |
Update a AI agent |
4.0.5 |
|
AIAgent.query |
Query AI agents |
4.0.5 |
|
AIAgent.chat |
Chat with AI agent |
4.0.5 |