API 概览 - IM 即时通讯

开发者中心

IM 即时通讯

客户端 API

API 概览

更新时间： 2025/07/10 11:41:58

本文介绍网易云信即时通讯 SDK（NetEase IM SDK，简称 NIM SDK）全量 API。

本文内容适用的开发平台或框架如下所示：

Android

iOS

Web

Windows

MacOS

HarmonyOS

小程序

Electron

Flutter

uni-app

API 架构

初始化

请参考各端初始化指南：

API	说明	起始版本
addLoginListener	注册登录状态监听器	v10.2.0
removeLoginListener	取消注册登录状态监听器	v10.2.0
addLoginDetailListener	注册登录连接状态监听器	v10.2.0
removeLoginDetailListener	取消注册登录连接状态监听器	v10.2.0

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册登录相关监听器	v10.2.0	v0.5.0
off("EventName")	取消注册登录相关监听器	v10.2.0	v0.5.0

API	说明	起始版本
listen	注册登录相关监听器	v10.3.0
cancel	取消注册登录相关监听器	v10.3.0

API	说明	起始版本
login	登录 IM	v10.2.0
logout	登出 IM	v10.2.0
getLoginUser	获取当前登录的账号	v10.2.0
getLoginStatus	获取当前登录状态	v10.2.0
getConnectStatus	获取当前登录连接状态	v10.2.0
getChatroomLinkAddress	获取聊天室连接地址	v10.2.0
setReconnectDelayProvider	设置登录重连延时的回调函数	v10.2.0
getCurrentLoginClient	查询当前登录终端的相关信息	v10.5.0

HarmonyOS

API	说明	起始版本
login	登录 IM	v0.5.0
logout	登出 IM	v0.5.0
getLoginUser	获取当前登录的账号	v0.5.0
getLoginStatus	获取当前登录状态	v0.5.0
getConnectStatus	获取当前登录连接状态	v0.5.0
getChatroomLinkAddress	获取聊天室连接地址	v0.5.0
setReconnectDelayProvider	设置登录重连延时的回调函数	v0.5.0
getCurrentLoginClient	查询当前登录终端的相关信息	v10.6.0

Flutter

API	说明	起始版本
login	登录 IM	v10.3.0
logout	登出 IM	v10.3.0
getLoginUser	获取当前登录的账号	v10.3.0
getLoginStatus	获取当前登录状态	v10.3.0
getConnectStatus	获取当前登录连接状态	v10.3.0
getChatroomLinkAddress	获取聊天室连接地址	v10.3.0
setReconnectDelayProvider	设置登录重连延时的回调函数	v10.3.0
getCurrentLoginClient	查询当前登录终端的相关信息	v10.9.0

多端登录与互踢

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
getLoginClients	获取当前多端登录列表	v10.2.0
kickOffline	主动将同时在线的其他客户端踢下线	v10.2.0
getKickedOfflineDetail	获取被踢下线的具体信息	v10.2.0
getDataSync	获取当前多端登录同步详情	v10.2.0

HarmonyOS

API	说明	起始版本
getLoginClients	获取当前多端登录列表	v0.5.0
kickOffline	主动将同时在线的其他客户端踢下线	v0.5.0
getKickedOfflineDetail	获取被踢下线的具体信息	v0.5.0
getDataSync	获取当前多端登录同步详情	v0.5.0

Flutter

API	说明	起始版本
getLoginClients	获取当前多端登录列表	v10.3.0
kickOffline	主动将同时在线的其他客户端踢下线	v10.3.0
getKickedOfflineDetail	获取被踢下线的具体信息	v10.3.0
getDataSync	获取当前多端登录同步详情	v10.3.0

云端会话

提供创建、删除、更新、获取会话，会话未读数、置顶会话、注册会话监听等接口。
提供创建、删除、更新、获取会话分组，注册会话分组监听等接口。

云端会话监听

Android/iOS/macOS/Windows

API	说明	起始版本
addConversationListener	注册会话相关监听器	v10.2.0
removeConversationListener	取消注册会话相关监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册会话相关监听器	v10.2.0	v0.5.0
off("EventName")	取消注册会话相关监听器	v10.2.0	v0.5.0

Flutter

API	说明	起始版本
listen	注册云端会话相关监听器	v10.3.0
cancel	取消注册云端会话相关监听器	v10.3.0

云端会话操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
createConversation	创建一条空会话	v10.2.0
deleteConversation	删除一条会话	v10.2.0
deleteConversationListByIds	批量删除会话列表	v10.2.0
getConversation	获取单条会话	v10.2.0
getConversationList	获取会话列表	v10.2.0
getConversationListByOption	获取指定会话列表	v10.2.0
getConversationListByIds	根据会话 ID 批量获取会话列表	v10.2.0
updateConversation	更新会话服务端扩展字段	v10.2.0
updateConversationLocalExtension	更新会话本地扩展字段	v10.2.0
stickTopConversation	置顶会话	v10.2.0
getStickTopConversationList	查询当前置顶的全量云端会话列表	Android/iOS/Web：v10.9.0 macOS/Windows/Electron：v10.9.10

HarmonyOS

API	说明	起始版本
createConversation	创建一条空会话	v0.5.0
deleteConversation	删除一条会话	v0.5.0
deleteConversationListByIds	批量删除会话列表	v0.5.0
getConversation	获取单条会话	v0.5.0
getConversationList	获取会话列表	v0.5.0
getConversationListByOption	获取指定会话列表	v0.5.0
getConversationListByIds	根据会话 ID 批量获取会话列表	v0.5.0
updateConversation	更新会话服务端扩展字段	v0.5.0
updateConversationLocalExtension	更新会话本地扩展字段	v0.5.0
stickTopConversation	置顶会话	v0.5.0
getStickTopConversationList	查询当前置顶的全量云端会话列表	v10.9.0

Flutter

API	说明	起始版本
createConversation	创建一条空会话	v10.3.0
deleteConversation	删除一条会话	v10.3.0
deleteConversationListByIds	批量删除会话列表	v10.3.0
getConversation	获取单条会话	v10.3.0
getConversationList	获取会话列表	v10.3.0
getConversationListByOption	获取指定会话列表	v10.3.0
getConversationListByIds	根据会话 ID 批量获取会话列表	v10.3.0
updateConversation	更新会话服务端扩展字段	v10.3.0
updateConversationLocalExtension	更新会话本地扩展字段	v10.3.0
stickTopConversation	置顶会话	v10.3.0
getStickTopConversationList	查询当前置顶的全量云端会话列表	v10.9.0

云端会话未读数

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
getTotalUnreadCount	获取全部会话的消息总未读数	v10.2.0
getUnreadCountByIds	获取指定会话列表的消息总未读数	v10.2.0
getUnreadCountByFilter	根据过滤参数获取相应的未读信息	v10.2.0
clearTotalUnreadCount	清空所有会话总的未读数	v10.2.0
clearUnreadCountByIds	清空指定会话列表的消息总未读数	v10.2.0
clearUnreadCountByTypes	根据会话类型清除指定会话类型的所有未读数	v10.2.0
clearUnreadCountByGroupId	根据会话分组 ID 清除分组内所有会话的消息总未读数	v10.2.0
subscribeUnreadCountByFilter	订阅过滤后的会话未读数变化	v10.2.0
unsubscribeUnreadCountByFilter	取消订阅过滤后的会话未读数变化	v10.2.0
markConversationRead	标记会话已读时间戳	v10.3.0
getConversationReadTime	获取会话已读时间戳	v10.3.0

HarmonyOS

API	说明	起始版本
getTotalUnreadCount	获取全部会话的消息总未读数	v0.5.0
getUnreadCountByIds	获取指定会话列表的消息总未读数	v0.5.0
getUnreadCountByFilter	根据过滤参数获取相应的未读信息	v0.5.0
clearTotalUnreadCount	清空所有会话总的未读数	v0.5.0
clearUnreadCountByIds	清空指定会话列表的消息总未读数	v0.5.0
clearUnreadCountByTypes	根据会话类型清除指定会话类型的所有未读数	v0.5.0
clearUnreadCountByGroupId	根据会话分组 ID 清除分组内所有会话的消息总未读数	v0.5.0
subscribeUnreadCountByFilter	订阅过滤后的会话未读数变化	v0.5.0
unsubscribeUnreadCountByFilter	取消订阅过滤后的会话未读数变化	v0.5.0
markConversationRead	标记会话已读时间戳	v1.2.0
getConversationReadTime	获取会话已读时间戳	v1.2.0

Flutter

API	说明	起始版本
getTotalUnreadCount	获取全部会话的消息总未读数	v10.3.0
getUnreadCountByIds	获取指定会话列表的消息总未读数	v10.3.0
getUnreadCountByFilter	根据过滤参数获取相应的消息未读数	v10.3.0
clearTotalUnreadCount	清空所有会话总的未读数	v10.3.0
clearUnreadCountByIds	清空指定会话列表的消息总未读数	v10.3.0
clearUnreadCountByTypes	根据会话类型清除指定会话类型的所有未读数	v10.3.0
subscribeUnreadCountByFilter	订阅过滤后的会话未读数变化	v10.3.0
unsubscribeUnreadCountByFilter	取消订阅过滤后的会话未读数变化	v10.3.0
markConversationRead	标记会话已读时间戳	v10.3.0
getConversationReadTime	获取会话已读时间戳	v10.3.0
clearUnreadCountByGroupId	根据会话分组 ID 清除分组内所有会话的消息总未读数	v10.8.0

云端会话分组监听

Android/iOS/macOS/Windows

API	说明	起始版本
addConversationGroupListener	注册会话分组监听器	v10.2.0
removeConversationGroupListener	取消注册会话分组监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册会话分组监听器	v10.2.0	v0.6.0
off("EventName")	取消注册会话分组监听器	v10.2.0	v0.6.0

Flutter

API	说明	起始版本
listen	注册云端会话分组监听器	v10.6.0
cancel	移除云端会话分组监听器	v10.6.0

云端会话分组操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
createConversationGroup	创建一个会话分组	v10.2.0
deleteConversationGroup	删除指定会话分组	v10.2.0
updateConversationGroup	更新指定会话分组	v10.2.0
addConversationsToGroup	将会话添加到分组	v10.2.0
removeConversationsFromGroup	将会话从分组中移除	v10.2.0
getConversationGroup	获取单个指定会话分组信息	v10.2.0
getConversationGroupList	获取全部会话分组列表	v10.2.0
getConversationGroupListByIds	批量获取指定会话分组列表	v10.2.0

HarmonyOS

API	说明	起始版本
createConversationGroup	创建一个会话分组	v0.6.0
deleteConversationGroup	删除指定会话分组	v0.6.0
updateConversationGroup	更新指定会话分组	v0.6.0
addConversationsToGroup	将会话添加到分组	v0.6.0
removeConversationsFromGroup	将会话从分组中移除	v0.6.0
getConversationGroup	获取单个指定会话分组信息	v0.6.0
getConversationGroupList	获取全部会话分组列表	v0.6.0
getConversationGroupListByIds	批量获取指定会话分组列表	v0.6.0

Flutter

API	说明	起始版本
createConversationGroup	创建一个云端会话分组	v10.6.0
deleteConversationGroup	删除指定云端会话分组	v10.6.0
updateConversationGroup	更新指定云端会话分组	v10.6.0
addConversationsToGroup	将云端会话添加到分组	v10.6.0
removeConversationsFromGroup	将云端会话从分组中移除	v10.6.0
getConversationGroup	获取单个指定云端会话分组信息	v10.6.0
getConversationGroupList	获取全部云端会话分组列表	v10.6.0
getConversationGroupListByIds	批量获取指定云端会话分组列表	v10.6.0

本地会话

提供创建、删除、更新、获取、置顶本地会话，本地会话消息未读数相关、注册本地会话监听等接口。

本地会话监听

Android/iOS/macOS/Windows

API	说明	起始版本
addConversationListener	注册本地会话相关监听器	v10.8.0
removeConversationListener	取消注册本地会话相关监听器	v10.8.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册本地会话相关监听器	v10.8.0	v1.3.0
off("EventName")	取消注册本地会话相关监听器	v10.8.0	v1.3.0

Flutter

API	说明	起始版本
listen	注册本地会话相关监听器	v10.6.0
cancel	取消注册本地会话相关监听器	v10.6.0

本地会话操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
createConversation	创建一条空本地会话	v10.8.0
updateConversationLocalExtension	更新本地会话的本地扩展信息	v10.8.0
deleteConversation	删除一条本地会话	v10.8.0
deleteConversationListByIds	根据会话 ID 批量删除本地会话列表	v10.8.0
stickTopConversation	置顶本地会话	v10.8.0
getConversation	根据会话 ID 获取单条本地会话	v10.8.0
getConversationList	获取所有本地会话列表	v10.8.0
getConversationListByIds	根据会话 ID 批量获取本地会话列表	v10.8.0
getConversationListByOption	根据指定的筛选条件获取本地会话列表	v10.8.0
getStickTopConversationList	查询当前置顶的全量本地会话列表	Android/iOS/Web：v10.9.0 macOS/Windows/Electron：v10.9.10

HarmonyOS

API	说明	起始版本
createConversation	创建一条空本地会话	v1.3.0
updateConversationLocalExtension	更新本地会话的本地扩展信息	v1.3.0
deleteConversation	删除一条本地会话	v1.3.0
deleteConversationListByIds	根据会话 ID 批量删除本地会话列表	v1.3.0
stickTopConversation	置顶本地会话	v1.3.0
getConversation	根据会话 ID 获取单条本地会话	v1.3.0
getConversationList	获取所有本地会话列表	v1.3.0
getConversationListByIds	根据会话 ID 批量获取本地会话列表	v1.3.0
getConversationListByOption	根据指定的筛选条件获取本地会话列表	v1.3.0
getStickTopConversationList	查询当前置顶的全量本地会话列表	v10.9.0

Flutter

API	说明	起始版本
createConversation	创建一条空本地会话	v10.6.0
updateConversationLocalExtension	更新会话的本地扩展信息	v10.6.0
deleteConversation	删除一条本地会话	v10.6.0
deleteConversationListByIds	根据会话 ID 批量删除本地会话列表	v10.6.0
stickTopConversation	置顶会话	v10.6.0
getConversation	根据会话 ID 获取单条本地会话	v10.6.0
getConversationList	获取所有本地会话列表	v10.6.0
getConversationListByIds	根据会话 ID 批量获取本地会话列表	v10.6.0
getConversationListByOption	根据指定的筛选条件获取本地会话列表	v10.6.0
getStickTopConversationList	查询当前置顶的全量本地会话列表	v10.9.0

本地会话未读数

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
getTotalUnreadCount	获取全部本地会话的消息总未读数	v10.8.0
getUnreadCountByIds	根据会话 ID 获取指定本地会话的消息总未读数	v10.8.0
getUnreadCountByFilter	根据过滤参数获取相应的本地会话的消息未读数	v10.8.0
clearTotalUnreadCount	清除所有本地会话的消息总未读数	v10.8.0
clearUnreadCountByIds	根据会话 ID 清除指定本地会话列表的消息未读数	v10.8.0
clearUnreadCountByTypes	根据会话类型清除指定本地会话类型的消息未读数	v10.8.0
subscribeUnreadCountByFilter	订阅指定过滤条件的本地会话消息未读数变化	v10.8.0
unsubscribeUnreadCountByFilter	取消订阅指定过滤条件的本地会话消息未读数变化	v10.8.0
markConversationRead	标记本地会话已读时间戳	v10.8.0
getConversationReadTime	获取本地会话已读时间戳	v10.8.0

HarmonyOS

API	说明	起始版本
getTotalUnreadCount	获取全部本地会话的消息总未读数	v1.3.0
getUnreadCountByIds	根据会话 ID 获取指定本地会话的消息总未读数	v1.3.0
getUnreadCountByFilter	根据过滤参数获取相应的本地会话的消息未读数	v1.3.0
clearTotalUnreadCount	清除所有本地会话的消息总未读数	v1.3.0
clearUnreadCountByIds	根据会话 ID 清除指定本地会话列表的消息未读数	v1.3.0
clearUnreadCountByTypes	根据会话类型清除指定本地会话类型的消息未读数	v1.3.0
subscribeUnreadCountByFilter	订阅指定过滤条件的本地会话消息未读数变化	v1.3.0
unsubscribeUnreadCountByFilter	取消订阅指定过滤条件的本地会话消息未读数变化	v1.3.0
markConversationRead	标记本地会话已读时间戳	v1.3.0
getConversationReadTime	获取本地会话已读时间戳	v1.3.0

Flutter

API	说明	起始版本
getTotalUnreadCount	获取全部本地会话的消息总未读数	v10.6.0
getUnreadCountByIds	根据会话 ID 获取指定本地会话的消息总未读数	v10.6.0
getUnreadCountByFilter	根据过滤参数获取相应的消息未读数	v10.6.0
clearTotalUnreadCount	清除所有本地会话的消息总未读数	v10.6.0
clearUnreadCountByIds	根据会话 ID 清除指定本地会话列表的消息未读数	v10.6.0
clearUnreadCountByTypes	根据会话类型清除指定本地会话类型的消息未读数	v10.6.0
subscribeUnreadCountByFilter	订阅指定过滤条件的本地会话消息未读数变化	v10.6.0
unsubscribeUnreadCountByFilter	取消订阅指定过滤条件的本地会话消息未读数变化	v10.6.0
markConversationRead	标记本地会话已读时间戳	v10.6.0
getConversationReadTime	获取本地会话已读时间戳	v10.6.0

消息

提供消息构建接口，支持构建多种类型的消息。
提供消息操作接口，包括发送、回复、转发、删除、更新、获取消息，注册消息监听，以及 PIN 消息、快捷评论、收藏等进阶操作接口。

消息构建

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
createTextMessage	创建一条文本消息	v10.2.0
createImageMessage	创建一条图片消息	v10.2.0
createAudioMessage	创建一条语音消息	v10.2.0
createVideoMessage	创建一条视频消息	v10.2.0
createFileMessage	创建一条文件消息	v10.2.0
createLocationMessage	创建一条地理位置消息	v10.2.0
createCustomMessage	创建一条自定义消息	v10.2.0
createForwardMessage	创建一条转发消息	v10.2.0
createTipsMessage	创建一条提示消息	v10.2.0
createCallMessage	创建一条话单消息	Android/iOS/Web：v10.2.6 macOS/Windows/Electron：v10.3.0
createCustomMessageWithAttachment	构造自定义消息	v10.5.0

HarmonyOS

API	说明	起始版本
createTextMessage	创建一条文本消息	v0.5.0
createImageMessage	创建一条图片消息	v0.5.0
createAudioMessage	创建一条语音消息	v0.5.0
createVideoMessage	创建一条视频消息	v0.5.0
createFileMessage	创建一条文件消息	v0.5.0
createLocationMessage	创建一条地理位置消息	v0.5.0
createCustomMessage	创建一条自定义消息	v0.5.0
createForwardMessage	创建一条转发消息	v0.5.0
createTipsMessage	创建一条提示消息	v0.5.0
createCallMessage	创建一条话单消息	v1.4.0
createCustomMessageWithAttachment	构造自定义消息	v10.0.0

Flutter

API	说明	起始版本
createTextMessage	创建一条文本消息	v10.3.0
createImageMessage	创建一条图片消息	v10.3.0
createAudioMessage	创建一条语音消息	v10.3.0
createVideoMessage	创建一条视频消息	v10.3.0
createFileMessage	创建一条文件消息	v10.3.0
createLocationMessage	创建一条地理位置消息	v10.3.0
createCustomMessage	创建一条自定义消息	v10.3.0
createForwardMessage	创建一条转发消息	v10.3.0
createTipsMessage	创建一条提示消息	v10.3.0
createCallMessage	创建一条话单消息	v10.3.0

消息监听

Android/iOS/macOS/Windows

API	说明	起始版本
addMessageListener	注册消息相关监听器	v10.2.0
removeMessageListener	取消注册消息相关监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册消息相关监听器	v10.2.0	v0.5.0
off("EventName")	取消注册消息相关监听器	v10.2.0	v0.5.0

Flutter

API	说明	起始版本
listen	注册消息相关监听器	v10.3.0
cancel	取消注册消息相关监听器	v10.3.0

消息基础操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
sendMessage	发送单条消息	v10.2.0
revokeMessage	撤回指定消息	v10.2.0
getMessageList	按条件分页获取会话内所有历史消息	v10.2.0
getMessageListByIds	根据消息客户端 ID 获取历史消息（Web 端不支持）	v10.2.0
deleteMessage	删除单条消息	v10.2.0
deleteMessages	批量删除消息	v10.2.0
clearHistoryMessage	清空会话内历史消息	v10.2.0
updateMessageLocalExtension	更新消息本地扩展字段（Web 端不支持）	v10.2.0
insertMessageToLocal	插入一条本地消息（Web 端不支持）	v10.2.0
cancelMessageAttachmentUpload	取消文件类附件上传	v10.2.0
modifyMessage	更新消息，对消息进行二次编辑	v10.4.0
getMessageListEx	按条件分页获取会话内所有历史消息注：较 `getMessageList` 方法，返回中新增下次查询的锚点消息	Android/iOS/Web：v10.9.0 macOS/Windows/Electron：v10.9.10
updateLocalMessage	更新本地插入的消息（Web 端不支持）	v10.9.10
getCloudMessageList	按条件分页获取会话内的云端消息	v10.9.10

HarmonyOS

API	说明	起始版本
sendMessage	发送单条消息	v0.5.0
revokeMessage	撤回指定消息	v0.5.0
getMessageList	按条件分页获取会话内所有历史消息	v0.5.0
getMessageListByIds	根据消息客户端 ID 获取历史消息	v0.5.0
deleteMessage	删除单条消息	v0.5.0
deleteMessages	批量删除消息	v0.5.0
clearHistoryMessage	清空会话内历史消息	v0.5.0
updateMessageLocalExtension	更新消息本地扩展字段	v0.5.0
insertMessageToLocal	插入一条本地消息	v0.5.0
cancelMessageAttachmentUpload	取消文件类附件上传	v0.5.0
modifyMessage	更新消息，对消息进行二次编辑	v10.0.0
getMessageListEx	按条件分页获取会话内所有历史消息注：较 `getMessageList` 方法，返回中新增下次查询的锚点消息	v10.9.0
updateLocalMessage	更新本地插入的消息	v10.9.10
getCloudMessageList	按条件分页获取会话内的云端消息	v10.9.10

Flutter

API	说明	起始版本
sendMessage	发送单条消息	v10.3.0
revokeMessage	撤回指定消息	v10.3.0
getMessageList	按条件分页获取会话内所有历史消息	v10.3.0
getMessageListByIds	根据消息客户端 ID 获取历史消息	v10.3.0
deleteMessage	删除单条消息	v10.3.0
deleteMessages	批量删除消息	v10.3.0
clearHistoryMessage	清空会话内历史消息	v10.3.0
updateMessageLocalExtension	更新消息本地扩展字段	v10.3.0
insertMessageToLocal	插入一条本地消息	v10.3.0
cancelMessageAttachmentUpload	取消文件类附件上传	v10.3.0
modifyMessage	更新消息，对消息进行二次编辑	v10.5.0
getMessageListEx	按条件分页获取会话内所有历史消息注：较 `getMessageList` 方法，返回中新增下次查询的锚点消息	v10.9.0
updateLocalMessage	更新本地插入的消息	v10.9.0

消息扩展操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
replyMessage	回复指定消息	v10.2.0
getMessageListByRefers	根据消息参考信息批量获取消息列表	v10.2.0
pinMessage	Pin 一条消息	v10.2.0
unpinMessage	取消 PIN 一条消息	v10.2.0
updatePinMessage	更新一条 PIN 消息	v10.2.0
getPinnedMessageList	获取会话内所有 PIN 消息	v10.2.0
addQuickComment	添加一条快捷评论	v10.2.0
removeQuickComment	移除一条快捷评论	v10.2.0
getQuickCommentList	获取指定消息的快捷评论列表	v10.2.0
addCollection	添加一个收藏	v10.2.0
removeCollections	移除收藏	v10.2.0
updateCollectionExtension	更新收藏扩展字段	v10.2.0
getCollectionListByOption	根据条件分页获取收藏列表	v10.2.0
getCollectionListExByOption	根据条件分页获取收藏列表注：较 `getCollectionListByOption` 方法，回参新增 `totalCount` 字段，表示收藏总数	v10.7.0
sendP2PMessageReceipt	发送单聊消息已读回执	v10.2.0
getP2PMessageReceipt	获取单聊消息已读回执	v10.2.0
isPeerRead	获取单聊消息是否已读	v10.2.0
sendTeamMessageReceipts	发送群组消息已读回执	v10.2.0
getTeamMessageReceipts	获取群组消息已读回执	v10.2.0
getTeamMessageReceiptDetail	获取群组消息已读回执状态详情	v10.2.0
searchCloudMessages	全文搜索云端历史消息	v10.2.0
getThreadMessageList	分页获取云端 Thread 历史消息列表	Android/iOS/Web：v10.2.6 macOS/Windows/Electron：v10.3.0
getLocalThreadMessageList	分页获取本地 Thread 历史消息列表（除 Web 端）	Android/iOS：v10.2.6 macOS/Windows/Electron：v10.3.0
searchLocalMessages	全文搜索本地历史消息（除 Web 端）	v10.7.0
searchCloudMessagesEx	全文搜索云端历史消息注：较 `searchCloudMessages` 方法，入参支持传入多个 keyword	v10.8.30
stopAIStreamMessage	打断 AI 数字人消息的流式输出，可选择直接停止输出，也可以选择撤回/更新 AI 数字人消息	v10.8.30
regenAIMessage	重新输出 AI 数字人消息	v10.8.30
setMessageFilter	消息过滤器（iOS 端不支持）	Android/Web：v10.9.0 macOS/Windows/Electron：v10.9.10

HarmonyOS

API	说明	起始版本
replyMessage	回复指定消息	v0.5.0
getMessageListByRefers	根据消息参考信息批量获取消息列表	v0.5.0
pinMessage	Pin 一条消息	v0.5.0
unpinMessage	取消 PIN 一条消息	v0.5.0
updatePinMessage	更新一条 PIN 消息	v0.5.0
getPinnedMessageList	获取会话内所有 PIN 消息	v0.5.0
addQuickComment	添加一条快捷评论	v0.5.0
removeQuickComment	移除一条快捷评论	v0.5.0
getQuickCommentList	获取指定消息的快捷评论列表	v0.5.0
addCollection	添加一个收藏	v0.5.0
removeCollections	移除收藏	v0.5.0
updateCollectionExtension	更新收藏扩展字段	v0.5.0
getCollectionListByOption	根据条件分页获取收藏列表	v0.5.0
sendP2PMessageReceipt	发送单聊消息已读回执	v0.5.0
getP2PMessageReceipt	获取单聊消息已读回执	v0.5.0
isPeerRead	获取单聊消息是否已读	v0.5.0
sendTeamMessageReceipts	发送群组消息已读回执	v0.5.0
getTeamMessageReceipts	获取群组消息已读回执	v0.5.0
getTeamMessageReceiptDetail	获取群组消息已读回执状态详情	v0.5.0
searchCloudMessages	全文搜索云端历史消息	v0.5.0
getThreadMessageList	分页获取云端 Thread 历史消息列表	v1.4.0
getLocalThreadMessageList	分页获取本地 Thread 历史消息列表	v1.4.0
searchLocalMessages	全文搜索本地历史消息	v10.6.0
searchCloudMessagesEx	全文搜索云端历史消息注：较 `searchCloudMessages` 方法，入参支持传入多个 keyword	v10.8.30
stopAIStreamMessage	打断 AI 数字人消息的流式输出，可选择直接停止输出，也可以选择撤回/更新 AI 数字人消息	v10.8.30
regenAIMessage	重新输出 AI 数字人消息	v10.8.30

Flutter

API	说明	起始版本
replyMessage	回复指定消息	v10.3.0
getMessageListByRefers	根据消息参考信息批量获取消息列表	v10.3.0
pinMessage	Pin 一条消息	v10.3.0
unpinMessage	取消 PIN 一条消息	v10.3.0
updatePinMessage	更新一条 PIN 消息	v10.3.0
getPinnedMessageList	获取会话内所有 PIN 消息	v10.3.0
addQuickComment	添加一条快捷评论	v10.3.0
removeQuickComment	移除一条快捷评论	v10.3.0
getQuickCommentList	获取指定消息的快捷评论列表	v10.3.0
addCollection	添加一个收藏	v10.3.0
removeCollections	移除收藏	v10.3.0
updateCollectionExtension	更新收藏扩展字段	v10.3.0
getCollectionListByOption	根据条件分页获取收藏列表	v10.3.0
sendP2PMessageReceipt	发送单聊消息已读回执	v10.3.0
getP2PMessageReceipt	获取单聊消息已读回执	v10.3.0
isPeerRead	获取单聊消息是否已读	v10.3.0
sendTeamMessageReceipts	发送群组消息已读回执	v10.3.0
getTeamMessageReceipts	获取群组消息已读回执	v10.3.0
getTeamMessageReceiptDetail	获取群组消息已读回执状态详情	v10.3.0
searchCloudMessages	全文搜索云端历史消息	v10.3.0
getThreadMessageList	分页获取云端 Thread 历史消息列表	v10.3.0
getLocalThreadMessageList	分页获取本地 Thread 历史消息列表	v10.3.0
stopAIStreamMessage	打断 AI 数字人消息的流式输出，可选择直接停止输出，也可以选择撤回/更新 AI 数字人消息	v10.8.0
regenAIMessage	重新输出 AI 数字人消息	v10.8.0
getCollectionListExByOption	根据条件分页获取收藏列表注：较 `getCollectionListByOption` 方法，回参新增 `totalCount` 字段，表示收藏总数	v10.9.0
searchCloudMessages	全文搜索云端历史消息	v10.9.0
setMessageFilter	消息过滤器	v10.9.0
searchCloudMessagesEx	全文搜索云端历史消息注：较 `searchCloudMessages` 方法，入参支持传入多个 `keyword`	v10.9.0
searchLocalMessages	全文搜索本地历史消息	v10.9.0

消息解析相关

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
registerCustomAttachmentParser	注册自定义消息附件解析器，解析自消息类型为 100 的消息附件	v10.5.0
unregisterCustomAttachmentParser	反注册自定义消息附件解析器	v10.5.0

HarmonyOS

API	说明	起始版本
registerCustomAttachmentParser	注册自定义消息附件解析器，解析自消息类型为 100 的消息附件	v10.6.0
unregisterCustomAttachmentParser	反注册自定义消息附件解析器	v10.6.0

Flutter

暂不支持

消息序列化

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
messageSerialization	消息序列化为字符串	v10.5.0
messageDeserialization	消息字符串转换为消息	v10.5.0

HarmonyOS

API	说明	起始版本
messageSerialization	消息序列化为字符串	v10.6.0
messageDeserialization	消息字符串转换为消息	v10.6.0

Flutter

API	说明	起始版本
messageSerialization	消息序列化为字符串	v10.5.0
messageDeserialization	消息字符串转换为消息	v10.5.0

系统通知

提供自定义通知相关接口。

系统通知监听

Android/iOS/macOS/Windows

API	说明	起始版本
addNoticationListener	注册系统通知相关监听器	v10.2.0
removeNotificationListener	取消注册系统通知相关监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册系统通知相关监听器	v10.2.0	v0.5.0
off("EventName")	取消注册系统通知相关监听器	v10.2.0	v0.5.0

Flutter

API	说明	起始版本
listen	注册系统通知相关监听器	v10.3.0
cancel	取消注册系统通知相关监听器	v10.3.0

系统通知发送

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
sendCustomNotification	发送自定义系统通知	v10.2.0

HarmonyOS

API	说明	起始版本
sendCustomNotification	发送自定义系统通知	v0.5.0

Flutter

API	说明	起始版本
sendCustomNotification	发送自定义系统通知	v10.3.0

群组

提供群组相关接口，包括注册群组监听，创建、修改、退出、解散、加入群组、获取群组相关信息等接口。

群组监听

Android/iOS/macOS/Windows

API	说明	起始版本
addTeamListener	注册群组相关监听器	v10.2.0
removeTeamListener	取消注册群组相关监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册群组相关监听器	v10.2.0	v0.5.0
off("EventName")	取消注册群组相关监听器	v10.2.0	v0.5.0

Flutter

API	说明	起始版本
listen	注册群组相关监听器	v10.3.0
cancel	取消注册群组相关监听器	v10.3.0

群组操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
createTeam	创建一个群组	v10.2.0
updateTeamInfo	修改群组信息	v10.2.0
leaveTeam	退出群组	v10.2.0
getTeamInfo	获取群组信息	v10.2.0
getTeamInfoByIds	根据群组 ID 批量获取群组信息	v10.2.0
dismissTeam	解散群组	v10.2.0
inviteMember	邀请成员加入群组	v10.2.0
acceptInvitation	接受入群邀请	v10.2.0
rejectInvitation	拒绝入群邀请	v10.2.0
kickMember	踢出群成员	v10.2.0
applyJoinTeam	申请加入群组	v10.2.0
acceptJoinApplication	同意入群申请	v10.2.0
rejectJoinApplication	拒绝入群申请	v10.2.0
updateTeamMemberRole	修改群成员角色	v10.2.0
transferTeamOwner	转让群主身份	v10.2.0
updateSelfTeamMemberInfo	修改自己的群成员信息	v10.2.0
updateTeamMemberNick	修改群成员昵称	v10.2.0
setTeamChatBannedMode	设置群组禁言模式	v10.2.0
setTeamMemberChatBannedStatus	设置群成员聊天禁言状态	v10.2.0
getJoinedTeamList	获取当前已经加入的群组列表	v10.2.0
getJoinedTeamCount	获取当前已经加入的群组数量	v10.2.0
getTeamMemberList	分页获取群组成员列表	v10.2.0
getTeamMemberListByIds	根据账号批量获取群组成员列表	v10.2.0
getTeamMemberInvitor	根据账号获取群组成员邀请人	v10.2.0
getTeamJoinActionInfoList	获取入群操作相关信息列表	v10.2.0
searchTeamByKeyword	根据关键字搜索群信息（包括高级群和超大群）	v10.3.0
searchTeamMembers	根据关键字搜索群成员（包括高级群和超大群）	v10.3.0
addTeamMembersFollow	添加特别关注的群成员列表	v10.5.0
removeTeamMembersFollow	移除特别关注的群成员列表	v10.5.0
clearAllTeamJoinActionInfo	清空所有入群申请	v10.6.0
deleteTeamJoinActionInfo	删除指定的入群申请	v10.6.0
inviteMemberEx	邀请成员加入群组	v10.8.10
getJoinedTeamMembers	查询自己加入的群组的成员信息列表	v10.9.10
setTeamJoinActionInfoRead	设置群申请已读	v10.9.20
getTeamJoinActionInfoUnreadCount	获取未读的群申请/邀请数量	v10.9.20

HarmonyOS

API	说明	起始版本
createTeam	创建一个群组	v0.5.0
updateTeamInfo	修改群组信息	v0.5.0
leaveTeam	退出群组	v0.5.0
getTeamInfo	获取群组信息	v0.5.0
getTeamInfoByIds	根据群组 ID 批量获取群组信息	v0.5.0
dismissTeam	解散群组	v0.5.0
inviteMember	邀请成员加入群组	v0.5.0
acceptInvitation	接受入群邀请	v0.5.0
rejectInvitation	拒绝入群邀请	v0.5.0
kickMember	踢出群成员	v0.5.0
applyJoinTeam	申请加入群组	v0.5.0
acceptJoinApplication	同意入群申请	v0.5.0
rejectJoinApplication	拒绝入群申请	v0.5.0
updateTeamMemberRole	修改群成员角色	v0.5.0
transferTeamOwner	转让群主身份	v0.5.0
updateSelfTeamMemberInfo	修改自己的群成员信息	v0.5.0
updateTeamMemberNick	修改群成员昵称	v0.5.0
setTeamChatBannedMode	设置群组禁言模式	v0.5.0
setTeamMemberChatBannedStatus	设置群成员聊天禁言状态	v0.5.0
getJoinedTeamList	获取当前已经加入的群组列表	v0.5.0
getJoinedTeamCount	获取当前已经加入的群组数量	v0.5.0
getTeamMemberList	分页获取群组成员列表	v0.5.0
getTeamMemberListByIds	根据账号批量获取群组成员列表	v0.5.0
getTeamMemberInvitor	根据账号获取群组成员邀请人	v0.5.0
getTeamJoinActionInfoList	获取入群操作相关信息列表	v0.5.0
searchTeamByKeyword	根据关键字搜索群信息（包括高级群和超大群）	v10.0.0
searchTeamMembers	根据关键字搜索群成员（包括高级群和超大群）	v10.0.0
addTeamMembersFollow	添加特别关注的群成员列表	10.9.20
removeTeamMembersFollow	移除特别关注的群成员列表	10.9.20
clearAllTeamJoinActionInfo	清空所有入群申请	v10.6.0
deleteTeamJoinActionInfo	删除指定的入群申请	v10.6.0
inviteMemberEx	邀请成员加入群组	v10.8.10
getJoinedTeamMembers	查询自己加入的群组的成员信息列表	v10.9.10
setTeamJoinActionInfoRead	设置群申请已读	v10.9.20
getTeamJoinActionInfoUnreadCount	获取未读的群申请/邀请数量	v10.9.20

Flutter

API	说明	起始版本
createTeam	创建一个群组	v10.3.0
updateTeamInfo	修改群组信息	v10.3.0
leaveTeam	退出群组	v10.3.0
getTeamInfo	获取群组信息	v10.3.0
getTeamInfoByIds	根据群组 ID 批量获取群组信息	v10.3.0
dismissTeam	解散群组	v10.3.0
inviteMember	邀请成员加入群组	v10.3.0
acceptInvitation	接受入群邀请	v10.3.0
rejectInvitation	拒绝入群邀请	v10.3.0
kickMember	踢出群成员	v10.3.0
applyJoinTeam	申请加入群组	v10.3.0
acceptJoinApplication	同意入群申请	v10.3.0
rejectJoinApplication	拒绝入群申请	v10.3.0
updateTeamMemberRole	修改群成员角色	v10.3.0
transferTeamOwner	转让群主身份	v10.3.0
updateSelfTeamMemberInfo	修改自己的群成员信息	v10.3.0
updateTeamMemberNick	修改群成员昵称	v10.3.0
setTeamChatBannedMode	设置群组禁言模式	v10.3.0
setTeamMemberChatBannedStatus	设置群成员聊天禁言状态	v10.3.0
getJoinedTeamList	获取当前已经加入的群组列表	v10.3.0
getJoinedTeamCount	获取当前已经加入的群组数量	v10.3.0
getTeamMemberList	分页获取群组成员列表	v10.3.0
getTeamMemberListByIds	根据账号批量获取群组成员列表	v10.3.0
getTeamMemberInvitor	根据账号获取群组成员邀请人	v10.3.0
getTeamJoinActionInfoList	获取入群操作相关信息列表	v10.3.0
searchTeamByKeyword	根据关键字搜索群信息（包括高级群和超大群）	v10.3.0
searchTeamMembers	根据关键字搜索群成员（包括高级群和超大群）	v10.3.0
addTeamMembersFollow	添加特别关注的群成员列表	v10.9.0
removeTeamMembersFollow	移除特别关注的群成员列表	v10.9.0
clearAllTeamJoinActionInfo	清空所有入群申请	v10.9.0
deleteTeamJoinActionInfo	删除指定的入群申请	v10.9.0
inviteMemberEx	邀请成员加入群组	v10.9.0

用户

提供用户资料相关接口，包括注册用户资料监听，获取、更新用户资料，拉黑用户等接口。

用户资料监听

Android/iOS/macOS/Windows

API	说明	起始版本
addUserListener	注册用户资料相关监听器	v10.2.0
removeUserListener	取消注册用户资料相关监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册用户资料相关监听器	v10.2.0	v0.5.0
off("EventName")	取消用户资料相关监听器	v10.2.0	v0.5.0

Flutter

API	说明	起始版本
listen	注册用户资料相关监听器	v10.3.0
cancel	取消注册用户资料相关监听器	v10.3.0

用户资料操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
getUserList	根据用户账号 ID 列表获取用户资料	v10.2.0
updateSelfUserProfile	更新自己的用户资料	v10.2.0
addUserToBlockList	添加指定用户进黑名单	v10.2.0
removeUserFromBlockList	将指定用户移出黑名单	v10.2.0
getBlockList	获取黑名单用户列表	v10.2.0
searchUserByOption	根据关键字信息搜索用户信息	v10.2.2
getUserListFromCloud	根据用户账号列表从服务器获取用户信息	Android/iOS/Web：v10.2.6 macOS/Windows/Electron：v10.3.1
checkBlock	查看指定用户是否在黑名单中	Android/iOS/Web：v10.9.0 macOS/Windows/Electron：v10.9.10

HarmonyOS

API	说明	起始版本
getUserList	根据用户账号 ID 列表获取用户资料	v0.5.0
updateSelfUserProfile	更新自己的用户资料	v0.5.0
addUserToBlockList	添加指定用户进黑名单	v0.5.0
removeUserFromBlockList	将指定用户移出黑名单	v0.5.0
getBlockList	获取黑名单用户列表	v0.5.0
searchUserByOption	根据关键字信息搜索用户信息	v1.4.0
getUserListFromCloud	根据用户账号列表从服务器获取用户信息	v1.4.0
checkBlock	查看指定用户是否在黑名单中	v10.9.0

Flutter

API	说明	起始版本
getUserList	根据用户账号 ID 列表获取用户资料	v10.3.0
updateSelfUserProfile	更新自己的用户资料	v10.3.0
addUserToBlockList	添加指定用户进黑名单	v10.3.0
removeUserFromBlockList	将指定用户移出黑名单	v10.3.0
getBlockList	获取黑名单用户列表	v10.3.0
searchUserByOption	根据关键字信息搜索用户信息	v10.3.0
getUserListFromCloud	根据用户账号列表从服务器获取用户信息	v10.3.0
checkBlock	查看指定用户是否在黑名单中	v10.9.0

用户状态订阅

提供用户状态订阅相关接口，包括注册用户状态订阅监听，获取、订阅用户状态，发布自定义状态等接口。

用户状态订阅监听

Android/iOS/macOS/Windows

API	说明	起始版本
addSubscribeListener	注册用户状态订阅相关监听器	v10.4.0
removeSubscribeListener	取消注册用户状态订阅相关监听器	v10.4.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册用户状态订阅相关监听器	v10.4.0	v10.6.0
off("EventName")	取消用户状态订阅相关监听器	v10.4.0	v10.6.0

Flutter

API	说明	起始版本
listen	注册用户状态订阅相关监听器	v10.3.4
cancel	取消注册用户状态订阅相关监听器	v10.3.4

用户状态订阅操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
subscribeUserStatus	订阅用户状态	v10.4.0
unsubscribeUserStatus	取消订阅用户状态	v10.4.0
publishCustomUserStatus	发布用户自定义状态	v10.4.0
queryUserStatusSubscriptions	查询用户状态订阅关系	v10.4.0

HarmonyOS

API	说明	起始版本
subscribeUserStatus	订阅用户状态	v10.6.0
unsubscribeUserStatus	取消订阅用户状态	v10.6.0
publishCustomUserStatus	发布用户自定义状态	v10.6.0
queryUserStatusSubscriptions	查询用户状态订阅关系	v10.6.0

Flutter

API	说明	起始版本
subscribeUserStatus	订阅用户状态	v10.3.4
unsubscribeUserStatus	取消订阅用户状态	v10.3.4
publishCustomUserStatus	发布用户自定义状态	v10.3.4
queryUserStatusSubscriptions	查询用户状态订阅关系	v10.3.4

好友

提供好友关系相关接口，包括注册好友关系监听，添加、删除好友，接受、拒绝好友申请，获取、设置好友信息等接口。

好友关系监听

Android/iOS/macOS/Windows

API	说明	起始版本
addFriendListener	注册好友关系相关监听器	v10.2.0
removeFriendListener	取消注册好友关系相关监听器器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册好友关系相关监听器	v10.2.0	v0.5.0
off("EventName")	取消注册好友关系相关监听器	v10.2.0	v0.5.0

Flutter

API	说明	起始版本
listen	注册好友关系相关监听器	v10.3.0
cancel	取消注册好友关系相关监听器	v10.3.0

好友关系操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
addFriend	添加好友	v10.2.0
deleteFriend	删除好友	v10.2.0
acceptAddApplication	接受好友申请	v10.2.0
rejectAddApplication	拒绝好友申请	v10.2.0
setFriendInfo	设置好友信息	v10.2.0
getFriendList	获取好友列表	v10.2.0
getFriendByIds	根据账号 ID 获取好友信息列表	v10.2.0
checkFriend	根据账号 ID 查询好友状态	v10.2.0
getAddApplicationList	获取申请添加好友信息列表	v10.2.0
getAddApplicationUnreadCount	获取未读的好友申请数量	Android/iOS: v10.2.1 macOS/Windows/Web/Electron: v10.2.2
setAddApplicationRead	设置好友申请已读	Android/iOS: v10.2.1 macOS/Windows/Web/Electron: v10.2.2
searchFriendByOption	根据关键字信息搜索好友信息	v10.2.2
clearAllAddApplication	清空所有好友申请	v10.6.0
deleteAddApplication	删除指定的好友申请	v10.6.0
setAddApplicationReadEx	设置好友申请已读	v10.9.20

HarmonyOS

API	说明	起始版本
addFriend	添加好友	v0.5.0
deleteFriend	删除好友	v0.5.0
acceptAddApplication	接受好友申请	v0.5.0
rejectAddApplication	拒绝好友申请	v0.5.0
setFriendInfo	设置好友信息	v0.5.0
getFriendList	获取好友列表	v0.5.0
getFriendByIds	根据账号 ID 获取好友信息列表	v0.5.0
checkFriend	根据账号 ID 查询好友状态	v0.5.0
getAddApplicationList	获取申请添加好友信息列表	v0.5.0
getAddApplicationUnreadCount	获取未读的好友申请数量	v0.5.0
setAddApplicationRead	设置好友申请已读	v0.5.0
searchFriendByOption	根据关键字信息搜索好友信息	v1.4.0
clearAllAddApplication	清空所有好友申请	v10.6.0
deleteAddApplication	删除指定的好友申请	v10.6.0
setAddApplicationReadEx	设置好友申请已读	v10.9.20

Flutter

API	说明	起始版本
addFriend	添加好友	v10.3.0
deleteFriend	删除好友	v10.3.0
acceptAddApplication	接受好友申请	v10.3.0
rejectAddApplication	拒绝好友申请	v10.3.0
setFriendInfo	设置好友信息	v10.3.0
getFriendList	获取好友列表	v10.3.0
getFriendByIds	根据账号 ID 获取好友信息列表	v10.3.0
checkFriend	根据账号 ID 查询好友状态	v10.3.0
getAddApplicationList	获取申请添加好友信息列表	v10.3.0
getAddApplicationUnreadCount	获取未读的好友申请数量	v10.3.0
setAddApplicationRead	设置好友申请已读	v10.3.0
searchFriendByOption	根据关键字信息搜索好友信息	v10.3.0
deleteAddApplication	删除指定的好友申请	v10.9.0

AI 数字人

提供 AI 数字人相关接口。数字人既可以是虚拟的 AI 对话伙伴、高效的协同工作助手、也可定制贴合业务所需更高安全性的本地大模型。

AI 数字人监听

Android/iOS/macOS/Windows

API	说明	起始版本
addAIListener	注册 AI 数字人相关监听器	v10.3.0
removeAIListener	取消注册 AI 数字人相关监听器器	v10.3.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册 AI 数字人关系相关监听器	v10.3.0	v10.6.0
off("EventName")	取消注册 AI 数字人关系相关监听器	v10.3.0	v10.6.0

Flutter

API	说明	起始版本
listen	注册 AI 数字人相关监听器	v10.3.0
cancel	取消注册 AI 数字人相关监听器	v10.3.0

AI 数字人操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
getAIUserList	根据用户账号 ID 列表获取 AI 数字人	v10.3.0
proxyAIModelCall	AI 数字人向 LLM 发起查询请求	v10.3.0
sendMessage	AI 数字人发送消息	v10.3.0
stopAIModelStreamCall	停止 AI 流式输出请求	v10.8.30

HarmonyOS

API	说明	起始版本
getAIUserList	根据用户账号 ID 列表获取 AI 数字人	v10.6.0
proxyAIModelCall	AI 数字人向 LLM 发起查询请求	v10.6.0
sendMessage	AI 数字人发送消息	v10.6.0
stopAIModelStreamCall	停止 AI 流式输出请求	v10.8.30

Flutter

API	说明	起始版本
getAIUserList	根据用户账号 ID 列表获取 AI 数字	v10.3.0
proxyAIModelCall	AI 数字人向 LLM 发起查询请求	v10.3.0
sendMessage	AI 数字人发送消息	v10.3.0
stopAIModelStreamCall	停止 AI 流式输出请求	v10.8.0

系统设置

提供系统设置相关接口，包括设置单聊/群聊消息免打扰模式、获取单聊/群聊消息免打扰模式、获取单聊消息免打扰列表、获取会话消息的免打扰状态等接口。

系统设置监听

Android/iOS/macOS/Windows

API	说明	起始版本
addSettingListener	注册系统设置相关监听器	v10.2.0
removeSettingListener	取消注册系统设置相关监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册系统设置相关监听器	v10.2.0	v0.6.0
off("EventName")	取消注册系统设置相关监听器	v10.2.0	v0.6.0

Flutter

API	说明	起始版本
listen	注册系统设置相关监听器	v10.3.0
cancel	取消注册系统设置相关监听器	v10.3.0

系统设置操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
setP2PMessageMuteMode	设置单聊消息免打扰模式	v10.2.0
getP2PMessageMuteMode	获取单聊消息免打扰模式	v10.2.0
getP2PMessageMuteList	获取开启单聊消息免打扰的用户列表	v10.2.0
setTeamMessageMuteMode	设置群消息免打扰模式	v10.2.0
getTeamMessageMuteMode	获取群消息免打扰模式	v10.2.0
getConversationMuteStatus	获取会话消息免打扰状态	v10.2.0
setAppBackground	设置应用前后台状态（仅 Web 端）	v10.2.0
setPushMobileOnDesktopOnline	设置当桌面端在线时，移动端是否需要推送	v10.2.0
setOfflinePushConfig	设置离线推送配置信息（仅 Web 端）	v10.2.0
setDndConfig	设置推送全局免打扰（除 Web 端）	v10.2.0
getDndConfig	获取推送免打扰配置信息（除 Web 端）	Android/iOS：v10.2.4 macOS/Windows/Electron：v10.3.1
getAllTeamMessageMuteMode	查询自己所在的所有群组的消息免打扰模式	v10.9.10
getPushMobileOnDesktopOnline	获取当桌面端在线时，移动端是否需要推送	v10.9.10

HarmonyOS

API	说明	起始版本
setP2PMessageMuteMode	设置单聊消息免打扰模式	v0.6.0
getP2PMessageMuteMode	获取单聊消息免打扰模式	v0.6.0
getP2PMessageMuteList	获取开启单聊消息免打扰的用户列表	v0.6.0
setTeamMessageMuteMode	设置群消息免打扰模式	v0.6.0
getTeamMessageMuteMode	获取群消息免打扰模式	v0.6.0
getConversationMuteStatus	获取会话消息免打扰状态	v0.6.0
setPushMobileOnDesktopOnline	设置当桌面端在线时，移动端是否需要推送	v0.6.0
setDndConfig	设置推送全局免打扰	v0.6.0
getDndConfig	获取推送免打扰配置信息	v0.6.0
getAllTeamMessageMuteMode	查询自己所在的所有群组的消息免打扰模式	v10.9.10
getPushMobileOnDesktopOnline	获取当桌面端在线时，移动端是否需要推送	v10.9.10

Flutter

API	说明	起始版本
setP2PMessageMuteMode	设置单聊消息免打扰模式	v10.3.0
getP2PMessageMuteMode	获取单聊消息免打扰模式	v10.3.0
getP2PMessageMuteList	获取开启单聊消息免打扰的用户列表	v10.3.0
setTeamMessageMuteMode	设置群消息免打扰模式	v10.3.0
getTeamMessageMuteMode	获取群消息免打扰模式	v10.3.0
getConversationMuteStatus	获取会话消息免打扰状态	v10.3.0
setPushMobileOnDesktopOnline	设置当桌面端在线时，移动端是否需要推送	v10.3.0
setDndConfig	设置推送全局免打扰	v10.3.0
getDndConfig	获取推送免打扰配置信息	v10.3.0
setAppBackground	设置应用前后台状态	v10.9.0
getPushMobileOnDesktopOnline	获取当桌面端在线时，移动端是否需要推送	v10.9.0

存储服务

提供存储服务相关接口。

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
addCustomStorageScene	添加自定义存储场景	v10.2.0
getStorageSceneList	获取存储场景列表	v10.2.0
createUploadFileTask	创建文件上传任务	v10.2.0
uploadFile	上传文件	v10.2.0
cancelUploadFile	取消文件上传	v10.2.0
downloadFile	下载文件（除 Web 端）	Android/iOS：v10.2.6 macOS/Windows/Electron：10.3.0
shortUrlToLong	短链接转长链接	Android/iOS/Web：v10.2.3 macOS/Windows/Electron：10.3.0
imageThumbUrl	生成图片缩略图链接	Android/iOS/Web：v10.2.6 macOS/Windows/Electron：10.3.0
videoCoverUrl	生成视频封面图链接	Android/iOS/Web：v10.2.6 macOS/Windows/Electron：10.3.0
downloadAttachment	下载消息附件	v10.3.0
getImageThumbUrl	获取图片消息中的缩略图链接	v10.3.0
getVideoCoverUrl	获取视频消息中的视频封面链接	v10.3.0
uploadFileWithMetaInfo	上传文件并返回资源信息（仅 Web）	v10.6.0

HarmonyOS

API	说明	起始版本
addCustomStorageScene	添加自定义存储场景	v0.5.0
getStorageSceneList	获取存储场景列表	v0.5.0
createUploadFileTask	创建文件上传任务	v0.5.0
uploadFile	上传文件	v0.5.0
cancelUploadFile	取消文件上传	v0.5.0
downloadFile	下载文件	v1.4.0
shortUrlToLong	短链接转长链接	v1.4.0
imageThumbUrl	生成图片缩略图链接	v1.3.0
videoCoverUrl	生成视频封面图链接	v1.3.0
downloadAttachment	下载消息附件	v10.0.0
getImageThumbUrl	获取图片消息中的缩略图链接	v10.0.0
getVideoCoverUrl	获取视频消息中的视频封面链接	v10.0.0

Flutter

API	描述	起始版本
addCustomStorageScene	添加自定义存储场景	v10.3.0
getStorageSceneList	获取存储场景列表	v10.3.0
createUploadFileTask	创建文件上传任务	v10.3.0
uploadFile	上传文件	v10.3.0
cancelUploadFile	取消文件上传	v10.3.0
downloadFile	下载文件	v10.3.0
shortUrlToLong	短链接转长链接	v10.3.0
downloadAttachment	下载消息附件	v10.3.0
getImageThumbUrl	获取图片消息中的缩略图链接	v10.3.0
getVideoCoverUrl	获取视频消息中的视频封面链接	v10.3.0
imageThumbUrl	生成图片缩略图链接	v10.9.0
videoCoverUrl	生成视频封面图链接	v10.9.0

聊天室

提供群组相关接口，包括注册/注销聊天室实例监听，创建、进入、退出、销毁聊天室等接口。
提供聊天室服务接口，包括注册/注销聊天室监听器、收发聊天室消息、管理聊天室成员、维护聊天室信息等。
提供聊天室消息构建接口，支持构建多种类型的聊天室消息。

聊天室实例监听

Android/iOS/macOS/Windows

API	说明	起始版本
addChatroomClientListener	注册聊天室实例监听器	v10.2.0
removeChatroomClientListener	取消注册聊天室实例监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册聊天室实例监听器	v10.2.0	v1.0.0
off("EventName")	取消注册聊天室实例监听器	v10.2.0	v1.0.0

Flutter

API	说明	起始版本
addChatroomClientListener	注册聊天室实例监听器	v10.5.0
removeChatroomClientListener	取消注册聊天室实例监听器	v10.5.0

聊天室实例

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
newInstance	构造一个新的聊天室实例	v10.2.0
destroyInstance	销毁指定聊天室实例	v10.2.0
getInstance	获取指定聊天室实例	v10.2.0
getInstanceList	获取当前已经存在的聊天室实例列表	v10.2.0
destroyAll	销毁当前的所有聊天室实例	v10.2.0

HarmonyOS

API	说明	起始版本
newInstance	构造一个新的聊天室实例	v1.0.0
destroyInstance	销毁指定聊天室实例	v1.0.0
getInstance	获取指定聊天室实例	v1.0.0
getInstanceList	获取当前已经存在的聊天室实例列表	v1.0.0
destroyAll	销毁当前的所有聊天室实例	v1.0.0

Flutter

API	说明	起始版本
newInstance	构造一个新的聊天室实例	v10.5.0
destroyInstance	销毁指定聊天室实例	v10.5.0
getInstance	获取指定聊天室实例	v10.5.0
getInstanceList	获取当前已经存在的聊天室实例列表	v10.5.0
destroyAll	销毁当前的所有聊天室实例	v10.5.0

聊天室监听

Android/iOS/macOS/Windows

API	说明	起始版本
addChatroomListener	注册聊天室监听器	v10.2.0
removeChatroomListener	取消注册聊天室监听器	v10.2.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	Web/uni-app/小程序/Node.js/Electron 起始版本	HarmonyOS 起始版本
on("EventName")	注册聊天室监听器	v10.2.0	v1.0.0
off("EventName")	取消注册聊天室监听器	v10.2.0	v1.0.0

Flutter

API	说明	起始版本
addChatroomListener	注册聊天室监听器	v10.5.0
removeChatroomListener	取消注册聊天室监听器	v10.5.0

聊天室操作

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
enter	进入聊天室	v10.2.0
exit	退出聊天室	v10.2.0
getChatroomInfo	获取聊天室信息	v10.2.0
getInstanceId	获取聊天室实例 ID	v10.2.0
getChatroomService	获取聊天室服务（除 Web 端）	v10.2.0
getStorageService	获取 IM 存储服务（除 Web 端）	v10.2.0
getChatroomQueueService	获取聊天室队列服务（除 Web 端）	v10.6.0

HarmonyOS

API	说明	起始版本
enter	进入聊天室	v1.0.0
exit	退出聊天室	v1.0.0
getChatroomInfo	获取聊天室信息	v1.0.0
getInstanceId	获取聊天室实例 ID	v1.0.0

Flutter

API	说明	起始版本
enter	进入聊天室	v10.5.0
exit	退出聊天室	v10.5.0
getChatroomInfo	获取聊天室信息	v10.5.0
getInstanceId	获取聊天室实例 ID	v10.5.0
getChatroomService	获取聊天室服务	v10.5.0
getStorageService	获取 IM 存储服务	v10.5.0
getChatroomQueueService	获取聊天室队列服务	v10.5.0

聊天室消息

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
createTextMessage	创建一条文本消息	v10.2.0
createImageMessage	创建一条图片消息	v10.2.0
createAudioMessage	创建一条语音消息	v10.2.0
createVideoMessage	创建一条视频消息	v10.2.0
createFileMessage	创建一条文件消息	v10.2.0
createLocationMessage	创建一条地理位置消息	v10.2.0
createCustomMessage	创建一条自定义消息	v10.2.0
createForwardMessage	创建一条转发消息	v10.2.0
createTipsMessage	创建一条提示消息	v10.2.0
sendMessage	发送聊天室消息	v10.2.0
cancelMessageAttachmentUpload	取消文件类附件上传	v10.2.0
getMessageList	分页获取聊天室历史消息	v10.2.0
getMessageListByTag	根据标签分页获取聊天室消息列表	v10.2.0

HarmonyOS

API	说明	起始版本
createTextMessage	创建一条文本消息	v1.0.0
createImageMessage	创建一条图片消息	v1.0.0
createAudioMessage	创建一条语音消息	v1.0.0
createVideoMessage	创建一条视频消息	v1.0.0
createFileMessage	创建一条文件消息	v1.0.0
createLocationMessage	创建一条地理位置消息	v1.0.0
createCustomMessage	创建一条自定义消息	v1.0.0
createForwardMessage	创建一条转发消息	v1.0.0
createTipsMessage	创建一条提示消息	v1.0.0
sendMessage	发送聊天室消息	v1.0.0
cancelMessageAttachmentUpload	取消文件类附件上传	v1.0.0
getMessageList	分页获取聊天室历史消息	v1.0.0
getMessageListByTag	根据标签分页获取聊天室消息列表	v1.0.0

Flutter

API	说明	起始版本
createTextMessage	创建一条文本消息	v10.5.0
createImageMessage	创建一条图片消息	v10.5.0
createAudioMessage	创建一条语音消息	v10.5.0
createVideoMessage	创建一条视频消息	v10.5.0
createFileMessage	创建一条文件消息	v10.5.0
createLocationMessage	创建一条地理位置消息	v10.5.0
createCustomMessage	创建一条自定义消息	v10.5.0
createForwardMessage	创建一条转发消息	v10.5.0
createTipsMessage	创建一条提示消息	v10.5.0
sendMessage	发送聊天室消息	v10.5.0
cancelMessageAttachmentUpload	取消文件类附件上传	v10.5.0
getMessageList	分页获取聊天室历史消息	v10.5.0
getMessageListByTag	根据标签分页获取聊天室消息列表	v10.5.0

聊天室成员

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
kickMember	将成员踢出聊天室	v10.2.0
getMemberListByOption	分页获取聊天室成员列表	v10.2.0
getMemberByIds	批量获取聊天室成员列表	v10.2.0
getMemberListByTag	根据标签分页获取聊天室成员列表	v10.2.0
getMemberCountByTag	根据标签获取聊天室成员数量	v10.2.0
updateMemberRole	更新聊天室成员角色	v10.2.0
setMemberBlockedStatus	设置聊天室成员黑名单状态	v10.2.0
setMemberChatBannedStatus	设置聊天室成员禁言状态	v10.2.0
setMemberTempChatBanned	设置聊天室成员临时禁言状态	v10.2.0
setTempChatBannedByTag	设置指定标签下的聊天室成员临时禁言状态	v10.2.0
updateSelfMemberInfo	更新本人的聊天室成员信息	v10.2.0

HarmonyOS

API	说明	起始版本
kickMember	将成员踢出聊天室	v1.0.0
getMemberListByOption	分页获取聊天室成员列表	v1.0.0
getMemberByIds	批量获取聊天室成员列表	v1.0.0
getMemberListByTag	根据标签分页获取聊天室成员列表	v1.0.0
getMemberCountByTag	根据标签获取聊天室成员数量	v1.0.0
updateMemberRole	更新聊天室成员角色	v1.0.0
setMemberBlockedStatus	设置聊天室成员黑名单状态	v1.0.0
setMemberChatBannedStatus	设置聊天室成员禁言状态	v1.0.0
setMemberTempChatBanned	设置聊天室成员临时禁言状态	v1.0.0
setTempChatBannedByTag	设置指定标签下的聊天室成员临时禁言状态	v1.0.0
updateSelfMemberInfo	更新本人的聊天室成员信息	v1.0.0

Flutter

API	说明	起始版本
kickMember	将成员踢出聊天室	v10.5.0
getMemberListByOption	分页获取聊天室成员列表	v10.5.0
getMemberByIds	批量获取聊天室成员列表	v10.5.0
getMemberListByTag	根据标签分页获取聊天室成员列表	v10.5.0
getMemberCountByTag	根据标签获取聊天室成员数量	v10.5.0
updateMemberRole	更新聊天室成员角色	v10.5.0
setMemberBlockedStatus	设置聊天室成员黑名单状态	v10.5.0
setMemberChatBannedStatus	设置聊天室成员禁言状态	v10.5.0
setMemberTempChatBanned	设置聊天室成员临时禁言状态	v10.5.0
setTempChatBannedByTag	设置指定标签下的聊天室成员临时禁言状态	v10.5.0
updateSelfMemberInfo	更新本人的聊天室成员信息	v10.5.0

聊天室信息

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron

API	说明	起始版本
updateChatroomInfo	更新聊天室信息	v10.2.0
updateChatroomLocationInfo	更新聊天室坐标信息	v10.2.0
updateChatroomTags	更新聊天室标签信息	v10.2.0

HarmonyOS

API	说明	起始版本
updateChatroomInfo	更新聊天室信息	v1.0.0
updateChatroomLocationInfo	更新聊天室坐标信息	v1.0.0
updateChatroomTags	更新聊天室标签信息	v1.0.0

Flutter

API	说明	起始版本
updateChatroomInfo	更新聊天室信息	v10.5.0
updateChatroomLocationInfo	更新聊天室坐标信息	v10.5.0
updateChatroomTags	更新聊天室标签信息	v10.5.0

聊天室队列监听

Android/iOS/macOS/Windows

API	说明	起始版本
addQueueListener	注册聊天室队列监听器	v10.6.0
removeQueueListener	取消注册聊天室队列监听器	v10.6.0

Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	起始版本
on("EventName")	注册聊天室队列监听器	v10.6.0
off("EventName")	取消注册聊天室队列监听器	v10.6.0

Flutter

API	说明	起始版本
addQueueListener	注册聊天室队列监听器	v10.6.1
removeQueueListener	取消注册聊天室队列监听器	v10.6.1

聊天室队列

Android/iOS/macOS/Windows/Web/uni-app/小程序/Node.js/Electron/HarmonyOS

API	说明	起始版本
queueOffer	在队列中新增或更新元素	v10.6.0
queuePoll	在队列中取出头元素或指定的元素	v10.6.0
queueList	排序列出所有元素	v10.6.0
queuePeek	查看队列的头元素	v10.6.0
queueDrop	清空队列	v10.6.0
queueInit	初始化队列	v10.6.0
queueBatchUpdate	批量更新队列元素	v10.6.0

Flutter

API	说明	起始版本
queueOffer	在队列中新增或更新元素	v10.6.1
queuePoll	在队列中取出头元素或指定的元素	v10.6.1
queueList	排序列出所有元素	v10.6.1
queuePeek	查看队列的头元素	v10.6.1
queueDrop	清空队列	v10.6.1
queueInit	初始化队列	v10.6.1
queueBatchUpdate	批量更新队列元素	v10.6.1

圈组

请参考 NIM SDK V9 API 文档：

API 架构

初始化

登录

登录相关监听

登录登出

多端登录与互踢

云端会话

云端会话监听

云端会话操作

云端会话未读数

云端会话分组监听

云端会话分组操作

本地会话

本地会话监听

本地会话操作

本地会话未读数

消息

消息构建

消息监听

消息基础操作

消息扩展操作

消息解析相关

消息序列化

系统通知

系统通知监听

系统通知发送

群组

群组监听

群组操作

用户

用户资料监听

用户资料操作

用户状态订阅

用户状态订阅监听

用户状态订阅操作

好友

好友关系监听

好友关系操作

AI 数字人

AI 数字人监听

AI 数字人操作

系统设置

系统设置监听

系统设置操作

存储服务

聊天室

聊天室实例监听

聊天室实例

聊天室监听

聊天室操作

聊天室消息

聊天室成员

聊天室信息

聊天室队列监听

聊天室队列

圈组

相关参考