开发者中心
IM 即时通讯
V9
视频教程知识库工单
中文
新手入门资源下载了解产品快速开始集成开发客户端 API服务端 API常见问题
在线咨询微信咨询电话咨询
Web
Web API 参考（NIM）
Web API 参考（Chatroom）
状态码/错误码
开发者中心IM 即时通讯客户端 APIWeb API 参考（NIM）

Web API 参考（NIM）

更新时间： 2024/04/01 16:06:21

本文介绍 Web SDK API 的概述性信息，并列出核心 API 与核心类或接口类，方便您查阅 API 信息。

  • NIMInterface 是 NIM SDK 的入口，负责建立长连接，登录，断开长连接，销毁实例、多端互踢等功能。
  • EventInterface 挂载了订阅发布事件相关的能力，如订阅，发布事件等。
  • FriendInterface 挂载了好友相关的 API，如获取，添加，申请，删除好友等。
  • PassThroughInterface 挂载了透传协议。
  • MessageExtendInterface 挂载了消息扩展相关的 API，如 thread 消息。
  • MessageInterface 挂载了消息相关的 API，如发送消息，发送文件消息，撤回，已读等。
  • MessageLogInterface 挂载了消息历史记录相关的 API，如查询历史消息。
  • SessionInterface 挂载了会话相关的 API，如查看会话，重置会话等
  • SystemMessageInterface 挂载了系统消息相关的 API，如发送自定义系统通知。
  • TeamInterface 挂载了群相关的 API，如获取，创建，离开群，群成员管理。
  • UserInterface 挂载了用户及关系相关的 API，如黑名单，静音列表，我的名片。
  • CloudSessionInterface 挂载了云端会话服务相关的 API，如查询云端会话列表，查询某个云端会话
  • CloudStorageInterface 挂载了云存储相关的 API，如上传并且预览文件、短链接转长链接
  • SignalingInterface 挂载了信令相关的 API，如创建，关闭频道
  • SuperTeamInterface 挂载了超级群相关的 API，如获取，创建，离开超级群
  • MiscInterface 挂载了杂项 API，如获取服务器时间戳（毫秒）
  • PluginInterface 挂载了 NIM 扩展服务 API

NIM.getInstance

下面是 NIM.getInstance 的初始化参数。这里只例举部分回调函数，完整初始化参数见 nim/types.NIMGetInstanceOptions。

参数 描述
NIMGetInstanceOptions.appKey [必填] 应用的 App Key，即您的应用在云信的账号

您可在云信控制台创建 App Key。详情参见创建应用。
NIMGetInstanceOptions.account [必填] 云信 IM 账号（又称 accid），即应用的用户在云信的唯一标识。

应用本身的用户帐号和云信的 IM 账号（accid）彼此独立。云信的 IM 账号只用于云信 IM 服务的鉴权，IM 账号并不等同于应用的用户账号。
NIMGetInstanceOptions.token [必填] IM 账号的登录凭证
该登录凭证只会在登录 IM （建立 SDK 与云信服务端的长连接）时校验一次。
NIMGetInstanceOptions.onconnect SDK 与云信服务端建立长连接的回调
NIMGetInstanceOptions.onwillreconnect SDK 与云信服务端即将重连的回调
NIMGetInstanceOptions.ondisconnect SDK 与云信服务端断开连接的回调
NIMGetInstanceOptions.onsyncdone 初始化同步完成的回调
NIMGetInstanceOptions.onerror 初始化阶段发生错误的回调
NIMGetInstanceOptions.onloginportschange 多端登录状态变化的回调
NIMGetInstanceOptions.onsessions 初始化同步时，接收会话列表的回调
NIMGetInstanceOptions.onupdatesessions 在线时批量更新会话的回调
NIMGetInstanceOptions.onStickTopSessions 初始化同步或在线时，接收远端置顶会话的回调
NIMGetInstanceOptions.onroamingmsgs 初始化同步时，接收漫游消息的回调
NIMGetInstanceOptions.onofflinemsgs 初始化同步时，接收离线消息的回调
NIMGetInstanceOptions.onmsg 多端同步或在线时，接收消息的回调
NIMGetInstanceOptions.onofflinesysmsgs 初始化同步时，接收离线系统通知的回调
NIMGetInstanceOptions.onroamingsysmsgs 初始化同步时，接收漫游的系统通知的回调
NIMGetInstanceOptions.onDeleteMsgSelf 多端同步时，单向删除消息的回调
用户在设备端 A 调用 deleteMsgSelf 或 deleteMsgSelfBatch 后，如果使用同一 IM 账号在设备端 B 登录，可通过该回调在设备端 B 收到消息被删除的通知。
NIMGetInstanceOptions.onbroadcastmsgs 初始化同步时，接收离线广播消息的回调
NIMGetInstanceOptions.onbroadcastmsg 在接收接收广播消息的回调
NIMGetInstanceOptions.onTeamMsgReceipt 在线接收群消息已读回执通知的回调
NIMGetInstanceOptions.onsysmsg 在线接收系统通知的回调
NIMGetInstanceOptions.onupdatesysmsg 在线接收系统通知更新的回调
NIMGetInstanceOptions.oncustomsysmsg 在线接收自定义系统通知的回调
NIMGetInstanceOptions.onofflinecustomsysmsgs 初始化同步时，接收离线自定义系统通知的回调
NIMGetInstanceOptions.onsysmsgunread 初始化同步时，接收系统通知未读数的回调
NIMGetInstanceOptions.onupdatesysmsgunread 在线接收系统通知未读数变更的回调
NIMGetInstanceOptions.onpushevents 订阅事件的回调
用户通过该回调在初始化同步或者在线时接收从云信服务端下推的订阅事件。
NIMGetInstanceOptions.onQuickComment 在线或多端同步时，接收“添加快捷评论通知”的回调
NIMGetInstanceOptions.onDeleteQuickComment 在线或多端同步时，接收“删除快捷评论通知”的回调
NIMGetInstanceOptions.onPinMsgChange 在线或多端同步时，接收“消息置顶通知”的回调
NIMGetInstanceOptions.onClearServerHistoryMsgs 多端同步或初始化同步时，接收“清除会话历史消息”通知的回调
NIMGetInstanceOptions.onSyncUpdateServerSession 多端同步时，接收“云端会话更新”通知的回调
NIMGetInstanceOptions.onblacklist 初始化时同步黑名单列表的回调
NIMGetInstanceOptions.onsyncmarkinblacklist 多端同步时，接收“拉黑/移出黑名单”事件的回调
NIMGetInstanceOptions.onmutelist 初始化时同步“静音列表”的回调。
NIMGetInstanceOptions.onsyncmarkinmutelist 多端同步时，接收“把某人静音的事件”的回调
NIMGetInstanceOptions.onfriends 同步好友列表的回调，会传入好友列表
NIMGetInstanceOptions.onsyncfriendaction 多端同步时，接收好友动作的回调。好友动作包括添加好友、好友申请、通过好友申请、拒绝好友申请、删除好友和更新好友备注。
NIMGetInstanceOptions.onmyinfo 初始化时同步自己的用户名片的回调。
NIMGetInstanceOptions.onupdatemyinfo 多端同步时，接收自己的用户名片更新的回调
NIMGetInstanceOptions.onSuperTeams 初始化同步时，接收超级群列表的回调
NIMGetInstanceOptions.onSyncCreateSuperTeam 多端同步时，接收“创建超级群”通知的回调
NIMGetInstanceOptions.onUpdateSuperTeam 在线或多端同步时，接收“更新超级群的通知”的回调
NIMGetInstanceOptions.onDismissSuperTeam 在线或多端同步时，接收“解散超级群的通知”的回调
NIMGetInstanceOptions.onTransferSuperTeam 在线或多端同步时，接收“转让超级群的通知”的回调
NIMGetInstanceOptions.onUpdateSuperTeamMember 在线或多端同步时，接收“超级群成员的信息变更”的回调
NIMGetInstanceOptions.onAddSuperTeamMembers 在线或多端同步时，接收“添加超级群成员的通知”的回调
NIMGetInstanceOptions.onRemoveSuperTeamMembers 在线或多端同步时，接收“删除超级群成员的通知”的回调
NIMGetInstanceOptions.onUpdateSuperTeamManagers 在线或多端同步时，接收“更新超级群管理员的通知”的回调
NIMGetInstanceOptions.onUpdateSuperTeamMembersMute 在线或多端同步时，接收“超级群成员被静音的通知”的回调
NIMGetInstanceOptions.onteams 初始化时同步群列表的回调
NIMGetInstanceOptions.onsynccreateteam 多端同步时，接收“创建群的通知”的回调
NIMGetInstanceOptions.onCreateTeam 在线或多端同步时，接收“创建群的通知”的回调
NIMGetInstanceOptions.onUpdateTeam 在线或多端同步时，接收“更新群的通知”的回调
NIMGetInstanceOptions.onDismissTeam 在线或多端同步时，接收“解散群的通知”的回调
NIMGetInstanceOptions.onTransferTeam 在线或多端同步时，接收“转让群的通知”的回调
NIMGetInstanceOptions.onupdateteammember 在线或多端同步时，接收“群成员的信息变更”的回调
NIMGetInstanceOptions.onAddTeamMembers 在线或多端同步时，接收“添加群成员的通知”的回调
NIMGetInstanceOptions.onRemoveTeamMembers 在线或多端同步时，接收“删除群成员的通知”的回调
NIMGetInstanceOptions.onUpdateTeamManagers 在线或多端同步时，接收“更新群管理员的通知”的回调
NIMGetInstanceOptions.onUpdateTeamMembersMute 在线或多端同步时，接收“群成员被静音的通知”的回调

NIMInterface

NIM SDK 的入口，负责建立长连接，登录，断开长连接，销毁实例、多端互踢等功能，完整的 API 请参见 NIMInterface。

方法 功能描述 对应 V10 API
logout 退出登录 V2NIMLoginService.logout
disconnect 断开 SDK 与云信服务端的长连接 无
connect 建立长连接，并且登录 无
destroy 销毁实例 同 V9 API
kick 将当前用户登录的其它端踢下线 V2NIMLoginService.kickOffline
setOptions 更新初始化配置 同 V9 API

MessageInterface

消息相关的 API，如发送消息，发送文件消息，撤回，已读等，完整的 API 请参见 MessageInterface。

方法 功能描述 对应 V10 API
sendText 发送文本消息
  • V2NIMMessageCreator.createTextMessage
  • V2NIMMessageService.sendMessage
    		•
    sendFile 发送文件消息
  • V2NIMMessageCreator.createFileMessage
  • V2NIMMessageServicesendMessage
    		•
    sendCustomMsg 发送自定义消息
  • V2NIMMessageCreator.createCustomMessage
  • V2NIMMessageService.sendMessage
    		•
    sendGeo 发送地理位置消息
  • V2NIMMessageCreator.createLocationMessage
  • V2NIMMessageService.sendMessage
    		•
    sendTipMsg 发送提醒消息
  • V2NIMMessageCreator.createTipsMessage
  • V2NIMMessageService.sendMessage
    		•
    resendMsg 重发消息 无
    forwardMsg 转发消息
  • V2NIMMessageCreator.createForwardMessage
  • V2NIMMessageService.sendMessage
    		•
    V2NIMMessageService.sendMsgReceipt 发送单聊消息的已读回执 V2NIMMessageService.sendP2PMessageReceipt
    sendTeamMsgReceipt 发送群消息（高级群）的已读回执 V2NIMMessageService.sendTeamMessageReceipts
    getTeamMsgReads 查询群组消息的已读、未读数量 V2NIMMessageService.getTeamMessageReceipts
    getTeamMsgReadAccounts 查询群消息已读的账号 V2NIMMessageService.getTeamMessageReceiptDetail
    recallMsg 撤回消息 V2NIMMessageService.revokeMessage
    deleteMsgSelf 单向删除消息 V2NIMMessageService.deleteMessage
    deleteMsgSelfBatch 批量单向删除消息 V2NIMMessageService.deleteMessages

    MessageLogInterface

    消息历史记录相关的 API，如查询历史消息，完整的 API 请参见 MessageLogInterface。

    方法 功能描述 对应 V10 API
    getHistoryMsgs 获取云端的消息历史记录 V2NIMMessageService.getMessageList
    clearServerHistoryMsgsWithSync 删除某个会话的云端消息历史记录，与漫游记录 V2NIMMessageService.clearHistoryMessage
    msgFtsInServer 云端全文检索消息(full text search)。返回的消息会按会话 session 分类返回 V2NIMMessageService.searchCloudMessages
    msgFtsInServerByTiming 云端全文检索消息-按时间分页搜索。返回的消息结果按时间自然排序 V2NIMMessageService.searchCloudMessages
    getLocalMsgs 获取本地数据库的消息记录 V2NIMMessageService.getMessageList
    getLocalMsgsByIdClients 获取 idClients 对应的本地消息列表 V2NIMMessageService.getMessageListByIds
    updateLocalMsg 更新本地消息。仅允许更新 localCustom 本地自定义扩展字段 无
    deleteLocalMsg 删除某一条本地消息 无
    deleteLocalMsgs 按条件删除消息 无
    deleteLocalMsgsBySession 删除某个会话下所有的本地消息 无
    deleteAllLocalMsgs 删除所有的本地消息 无
    saveMsgsToLocal 将消息存储至本地数据库 无

    EventInterface

    订阅发布事件相关的能力，如订阅，发布事件等，完整的 API 请参见 EventInterface。

    方法 功能描述 对应 V10 API
    publishEvent 发布某事件 无
    subscribeEvent 订阅某事件 无
    unSubscribeEventsByAccounts 按账号取消订阅关系 无
    querySubscribeEventsByAccounts 按账号获取指定事件的订阅关系 无
    unSubscribeEventsByType 取消指定事件的全部订阅关系 无
    querySubscribeEventsByAccounts 按账号获取指定事件的订阅关系 无
    querySubscribeEventsByType 获取指定事件的订阅关系 无

    FriendInterface

    好友相关的 API，如获取，添加，申请，删除好友等，完整的 API 请参见 FriendInterface。

    方法 功能描述 对应 V10 API
    getFriends 获取好友
  • V2NIMFriendService.getFriendList
  • V2NIMFriendService.getFriendByIds
    		•
    addFriend 直接加为好友 V2NIMFriendService.addFriend
    applyFriend 申请加为好友 V2NIMFriendService.addFriend
    passFriendApply 通过好友申请 V2NIMFriendService.acceptAddApplication
    rejectFriendApply 拒绝好友申请 V2NIMFriendService.rejectAddApplication
    deleteFriend 删除好友 V2NIMFriendService.deleteFriend
    updateFriend 更新好友 V2NIMFriendService.setFriendInfo
    isMyFriend 是否为我的好友 V2NIMFriendService.checkFriend

    PassThroughInterface

    透传协议，完整的 API 请参见 PassThroughInterface。

    方法 功能描述 对应 V10 API
    httpRequestProxy 透传协议 无

    MessageExtendInterface

    消息扩展相关的 API，如 thread 消息，完整的 API 请参见 MessageExtendInterface。

    方法 功能描述 对应 V10 API
    getThreadMsgs 获取 thread 消息列表 V2NIMMessageService.getMessageListByRefers
    getMsgsByIdServer 通过消息 id 等信息批量查询历史消息，thread 聊天专用 V2NIMMessageService.getMessageListByRefers
    addQuickComment 添加快捷评论 V2NIMMessageService.addQuickComment
    deleteQuickComment 删除快捷评论 V2NIMMessageService.removeQuickComment
    getQuickComments 批量查询消息的快捷评论 V2NIMMessageService.getQuickCommentList
    addCollect 添加收藏 V2NIMMessageService.addCollection
    deleteCollects 删除收藏。返回结果为被成功删除的收藏个数 V2NIMMessageService.removeCollections
    updateCollect 更新收藏，只能更新 custom 字段 V2NIMMessageService.updateCollectionExtension
    getCollects 查询收藏列表 V2NIMMessageService.getCollectionListByOption
    addMsgPin Pin 住一条消息 V2NIMMessageService.pinMessage
    updateMsgPin 更新被 Pin 的消息 V2NIMMessageService.updatePinMessage
    deleteMsgPin 取消消息的 Pin 状态 V2NIMMessageService.unpinMessage
    getMsgPins 查询某会话下的 Pin 消息列表 V2NIMMessageService.getPinnedMessageList

    SessionInterface

    会话相关的 API，如查看会话，重置会话等，完整的 API 请参见 SessionInterface。

    方法 功能描述 对应 V10 API
    getLocalSession 通过 sessionId 获取本地数据库里的会话 V2NIMConversationService.getConversation
    getLocalSessions 分页查询本地数据库里的会话列表
  • V2NIMConversationService.getConversationList
  • V2NIMConversationService.getConversationListByOption
    		•
    insertLocalSession 往本地数据库中插入一条会话记录 无
    updateLocalSession 更新本地数据库里的会话 无
    deleteLocalSession 删除指定的本地数据库会话 无
    setCurrSession 设置“进入当前会话” V2NIMConversationService.clearUnreadCountByIds
    resetCurrSession 取消 setCurrSession 的效果 无
    resetSessionUnread 重置某个会话的未读数 V2NIMConversationService.clearUnreadCountByIds
    resetSessionsUnread 重置某些会话的未读数 V2NIMConversationService.clearUnreadCountByIds
    resetAllSessionUnread 重置所有会话的未读数 V2NIMConversationService.clearUnreadCountByIds
    getStickTopSessions 获取云端置顶会话的列表 V2NIMConversationService.getConversationListByOption
    addStickTopSession 添加云端置顶的会话 V2NIMConversationService.stickTopConversation
    deleteStickTopSession 取消云端置顶的会话 V2NIMConversationService.stickTopConversation
    updateStickTopSession 更新云端置顶的会话（目前仅能更新它的扩展字段） V2NIMConversationService.updateConversation

    SystemMessageInterface

    系统消息相关的 API，如发送自定义系统通知，完整的 API 请参见 SystemMessageInterface。

    方法 功能描述 对应 V10 API
    sendCustomSysMsg 发送自定义系统通知 V2NIMNotificationService.sendCustomNotification
    markSysMsgRead 向服务器回包标记系统消息端测已读，下次服务器不需要将此消息作离线系统消息发下来 无
    getLocalSysMsgs 获取本地数据库里的系统通知 无
    updateLocalSysMsg 更新本地数据库里的系统通知 无
    deleteLocalSysMsg 删除本地数据库里的系统通知 无
    deleteAllLocalSysMsgs 删除所有本地数据库里的系统通知 无

    TeamInterface

    群相关的 API，如获取，创建，离开群，群成员管理，完整的 API 请参见 TeamInterface。

    方法 功能描述 对应 V10 API
    getTeam 获取群 V2NIMTeamService.getTeamInfo
    getTeams 获取群列表 V2NIMTeamService.getJoinedTeamList
    getTeamsById 通过一批 teamId 来获取若干个群 V2NIMTeamService.getTeamInfoByIds
    createTeam 创建群 V2NIMTeamService.createTeam
    updateTeam 更新群 V2NIMTeamService.updateTeamInfo
    transferTeam 转让群，群主可操作 V2NIMTeamService.transferTeamOwner
    dismissTeam 解散群，群主可操作 V2NIMTeamService.dismissTeam
    leaveTeam 主动退群 V2NIMTeamService.leaveTeam
    muteTeamAll 群组全体禁言 V2NIMTeamService.setTeamChatBannedMode
    getTeamMembers 获取群成员 V2NIMTeamService.getTeamMemberList
    getMutedTeamMembers 获取群禁言成员列表 V2NIMTeamService.getTeamMemberList
    addTeamMembers 添加群成员 V2NIMTeamService.inviteMember
    acceptTeamInvite （用户）接受群邀请 V2NIMTeamService.acceptInvitation
    rejectTeamInvite （用户）拒绝群邀请 V2NIMTeamService.rejectInvitation
    removeTeamMembers 踢人出群 V2NIMTeamService.kickMember
    addTeamManagers 添加群管理员 V2NIMTeamService.updateTeamMemberRole
    removeTeamManagers 移除群管理员 V2NIMTeamService.updateTeamMemberRole
    updateInfoInTeam 修改自己在群里的信息 V2NIMTeamService.updateSelfTeamMemberInfo
    updateNickInTeam 修改别人的群昵称 V2NIMTeamService.updateTeamMemberNick
    updateMuteStateInTeam 更新群成员禁言状态 V2NIMTeamService.setTeamMemberChatBannedStatus
    getTeamMemberByTeamIdAndAccount 通过群 ID 及成员账号获取群成员信息 V2NIMTeamService.getTeamMemberListByIds
    getTeamMemberInvitorAccid 获取群成员的邀请者 accid V2NIMTeamService.getTeamMemberInvitor
    applyTeam 申请入群 V2NIMTeamService.applyJoinTeam
    passTeamApply 通过群申请 V2NIMTeamService.acceptJoinApplication
    rejectTeamApply （管理员）拒绝群申请 V2NIMTeamService.rejectJoinApplication

    UserInterface

    用户及关系相关的 API，如黑名单，静音列表，我的名片，完整的 API 请参见 UserInterface。

    方法 功能描述 对应 V10 API
    getUser 获取用户名片 V2NIMUserService.getUserList
    getUsers 获取一批用户的名片，每次最多 150 个 V2NIMUserService.getUserList
    updateMyInfo 更新我的名片 V2NIMUserService.updateSelfUserProfile
    isUserInBlackList 查看某人是否在当前用户在黑名单里 V2NIMUserService.getBlockList
    getRelations 获取关系(黑名单和静音列表)
  • V2NIMUserService.getBlockList
  • V2NIMUserService.getP2PMessageMuteList
    		•
    addToBlacklist 加入黑名单 V2NIMUserService.addUserToBlockList
    removeFromBlacklist 移出黑名单 V2NIMUserService.removeUserFromBlockList
    addToMutelist 加入静音列表 V2NIMUserService.setP2PMessageMuteMode
    removeFromMutelist 移出静音列表 V2NIMUserService.setP2PMessageMuteMode
    isUserInBlackList 查看某人是否在当前用户在黑名单里 V2NIMUserService.getBlockList

    CloudSessionInterface

    这里只例举部分 API，完整的 API 请参见 CloudSessionInterface。

    方法 功能描述 对应 V10 API
    getServerSessions 查询云端会话列表 V2NIMConversationService.getConversationList
    getServerSession 查询某个云端会话 V2NIMConversationService.getConversation
    updateServerSession 更新云端会话 V2NIMConversationService.updateConversation
    deleteServerSessions 删除云端会话列表 V2NIMConversationService.deleteConversationListByIds

    CloudStorageInterface

    云端会话服务相关的 API，如查询云端会话列表，查询某个云端会话，完整的 API 请参见 CloudStorageInterface。

    方法 功能描述 对应 V10 API
    previewFile 上传并且预览文件 V2NIMStorageService.uploadFile
    getNosOriginUrl 短链接转长链接 V2NIMStorageService.shortUrlToLong
    audioToText 音频转文字 V2NIMMessageService.voiceToText
    stripImageMeta 去除图片元信息 无
    qualityImage 修改图片质量 无
    interlaceImage interlace 图片 无
    rotateImage 旋转图片 无
    blurImage 模糊图片 无
    cropImage 剪裁图片 无
    thumbnailImage 生成图片的略缩图 无
    processImage 处理图片 无

    SignalingInterface

    信令相关的 API，如创建，关闭频道，详细内容见 SignalingInterface。

    信令相关的事件通过nim.on 监听，详细内容见 NIMSignalingEventInterface。

    事件 功能描述
    signalingNotify 收到在线通知
    signalingMutilClientSyncNotify 收到多端同步通知
    signalingChannelsSyncNotify 收到频道成员变更同步
    signalingUnreadMessageSyncNotify 收到未读信令消息通知

    它的使用方式如

    jsnim.on('signalingNotify', (res) => {
  console.log('收到在线通知', res)
})
    方法 功能描述
    signalingCallEx 呼叫加入音视频频道： 创建一个频道，己方加入，并邀请对方加入音视频的频道。
    signalingCall 呼叫：创建一个频道，己方加入，并邀请对方加入频道。
    signalingCreateAndJoin 如果不存在房间，则创建一个频道，并且己方加入。如果已存在频道，则己方直接加入。
    signalingCreate 创建频道
    signalingDelay 延长频道的有效期
    signalingClose 关闭频道
    signalingGetChannelInfo 查询频道信息。根据 channelName 查询房间信息。
    signalingJoin 加入频道
    signalingLeave 离开频道
    signalingInvite 邀请某人进入频道
    signalingCancel 取消邀请
    signalingReject 拒绝进入频道的邀请
    signalingAccept 接受进入频道的邀请
    signalingMarkMsgRead 标记信令消息已收到, 下次不会在离线同步中收到此消息
    signalingControl 发送自定义信令
    signalingJoinAndAccept 加入频道并接受邀请

    SuperTeamInterface

    超级群相关的 API，如获取，创建，离开超级群，完整的 API 请参见 SuperTeamInterface。

    方法 功能描述 对应 V10 API
    getSuperTeam 获取超级群 V2NIMTeamService.getTeamInfo
    getSuperTeams 获取超级群列表 V2NIMTeamService.getJoinedTeamList
    updateSuperTeam 更新超级群 V2NIMTeamService.updateTeamInfo
    transferSuperTeam 转让超级群，群主可操作 V2NIMTeamService.transferTeamOwner
    leaveSuperTeam 主动退出超级群 V2NIMTeamService.leaveTeam
    updateSuperTeamMute 超级群全体禁言 V2NIMTeamService.setTeamChatBannedMode
    getSuperTeamMembersByJoinTime 分页获取超级群成员 V2NIMTeamService.getTeamMemberList
    getSuperTeamMembersByAccounts 通过一批 account ID 获取若干个超级群 V2NIMTeamService.getTeamMemberListByIds
    getAllSuperTeamMembers 获取全部超级群成员，数据量非常多时会分多次 done 返回 V2NIMTeamService.getTeamMemberList
    getMutedSuperTeamMembers 获取超级群禁言成员列表 V2NIMTeamService.getTeamMemberList
    addSuperTeamMembers 添加超级群的成员 V2NIMTeamService.inviteMember
    acceptSuperTeamInvite （用户）接受超级群邀请 V2NIMTeamService.acceptInvitation
    rejectSuperTeamInvite （用户）拒绝超级群的邀请 V2NIMTeamService.rejectJoinApplication
    removeSuperTeamMembers 踢人出超级群 V2NIMTeamService.kickMember
    addSuperTeamManagers 添加超级群的管理员 V2NIMTeamService.updateTeamMemberRole
    removeSuperTeamManagers 移除超级群的管理员 V2NIMTeamService.updateTeamMemberRole
    updateNickInSuperTeam 修改别人的超级群的昵称 V2NIMTeamService.updateTeamMemberNick
    updateInfoInSuperTeam 修改自己在超级群里的信息 V2NIMTeamService.updateSelfTeamMemberInfo
    updateSuperTeamMembersMute 更新超级群成员禁言状态 V2NIMTeamService.setTeamMemberChatBannedStatus
    applySuperTeam 申请入超级群 V2NIMTeamService.applyJoinTeam
    passSuperTeamApply （管理员）通过超级群申请 V2NIMTeamService.acceptJoinApplication
    rejectSuperTeamApply （管理员）拒绝超级群申请 V2NIMTeamService.rejectJoinApplication

    MiscInterface

    一些其它的接口，完整的 API 请参见 MiscInterface。

    方法 功能描述 对应 V10 API
    filterClientAntispam 检查客户端反垃圾 V2NIMClientAntispamUtil.checkTextAntispam
    getClientAntispamLexicon 获取反垃圾词库 无
    getServerTime 获取服务器时间戳 无
    在线咨询微信咨询电话咨询
    此文档是否对你有帮助？
    有帮助
    去反馈
    • NIM.getInstance
    • NIMInterface
    • MessageInterface
    • MessageLogInterface
    • EventInterface
    • FriendInterface
    • PassThroughInterface
    • MessageExtendInterface
    • SessionInterface
    • SystemMessageInterface
    • TeamInterface
    • UserInterface
    • CloudSessionInterface
    • CloudStorageInterface
    • SignalingInterface
    • SuperTeamInterface
    • MiscInterface