NIM Web SDK

完整的 NIM SDK 由 NIMInterface, ChatroomServiceInterface 组成。

• V2NIM 是 NIM SDK 的入口，负责创建实例
• V2NIMLoginService 挂载登录模块接口
• V2NIMConversationService 挂载会话模块接口
• V2NIMConversationIdUtil 会话工具类
• V2NIMMessageCreator 构造各种类型消息
• V2NIMMessageService 挂载消息模块接口
• V2NIMTeamService 群组相关接口
• V2NIMUserService 用户相关接口
• V2NIMFriendService 好友相关接口
• V2NIMClientAntispamUtil 客户端反垃圾工具类
• V2NIMStorageService 云端存储工具类
• V2NIMNotificationService 通知类
• V2NIMConst V2 枚举值以及 V2NIMErrorCode 常量
• V2NIMConversationGroupService 挂载会话分组模块接口。ESM 模式时，需要动态引入
• V2NIMSettingService 设置相关接口。ESM 模式时，需要动态引入
• DataStructureConverter v1 & v2 消息转换工具类。ESM 模式时，需要动态引入
• V2NIMMessageConverter 消息序列化工具。ESM 模式时，需要动态引入
• V2NIMAIService AI 数字人相关接口。ESM 模式时，需要动态引入
• V2NIMSignallingService v2 信令模块接口。ESM 模式时,需要动态引入

事件通知如下

• V2NIMLoginListener 登录模块事件
• V2NIMConversationListener 会话模块事件
• V2NIMMessageListener 消息模块事件
• V2NIMTeamListener 群组模块事件
• V2NIMUserListener 用户模块事件
• V2NIMFriendListener 好友模块事件
• V2NIMNotificationListener 通知模块事件
• V2NIMConversationGroupListener 会话分组模块事件。ESM 模式时，需要动态引入
• V2NIMSettingListener 设置模块事件。ESM 模式时，需要动态引入
• V2NIMAIListener AI 数字人相关事件。ESM 模式时，需要动态引入
• V2NIMSignallingListener v2 信令模块事件。ESM 模式时,需要动态引入

V2NIM

V2NIM 是 SDK 入口类。通过该类创建实例。如果是 esm 模式引入，还需要调用 registerService 注册模块，以及环境变量

方法	功能描述
V2NIM.getInstance	单例模式获取实例
V2NIM.registerService	注册模块. ESM 模式使用

NIM.getInstance

下面是NIMInterfaceStatic.getInstance的初始化参数。这里只例举部分回调函数，完整初始化参数见 NIMInitializeOptions，以及NIMOtherOptions

注意，初始化有两个参数，调用方式为: NIM.getInstance(param1, param2)。param1 为 NIMInitializeOptions, param2 为 NIMOtherOptions

const nim = V2NIM.getInstance(
  /**
   * param1: NIMInitializeOptions
   */
  {
    appkey: 'YOUR_APPKEY',
    token: 'YOUR_TOKEN',
    account: 'YOUR_ACCOUNT'
  },
  /**
   * param2: NIMOtherOptions
   */
  {
    /**
     * 会话初始化设置
     */
    sessionConfig: {
      /**
       * 用户可以根据应用场景，设置消息是否要计入未读数。
       */
      unreadCountFilterFn: function (msg) {
        return true
      }
    },
    /**
     * 同步初始化设置
     */
    syncOptions: {
      /**
       * 是否同步置顶会话消息
       */
      stickTopSessions: true,
      /**
       * 是否同步用户信息
       */
      myInfo: false
    }
  }
)

NIMInitializeOptions

提供最为基础的初始化参数。该参数的完整属性列表请参考NIMInitializeOptions

属性	功能描述
NIMInitializeOptions.appkey	应用 appkey
NIMInitializeOptions.account	IM 账户
NIMInitializeOptions.token	IM 账户 token
NIMInitializeOptions.authType	token 的认证模式
NIMInitializeOptions.debugLevel	日志分级

NIMOtherOptions

提供一些扩展初始化参数。该参数的完整属性列表请参考NIMOtherOptions。

属性	功能描述
NIMOtherOptions.cloudStorageConfig	cloud storage 模块配置
NIMOtherOptions.sessionConfig	session 模块配置
NIMOtherOptions.syncOptions	同步模块的选项配置

V2NIMLoginService

挂载了登录相关 API。调用示例: nim.V2NIMLoginService.login。完整的 API 请参见 V2NIMLoginService

方法	功能描述
V2NIMLoginService.login	登录 IM
V2NIMLoginService.logout	登出 IM
V2NIMLoginService.kickOffline	踢出当前用户从其它端登录上来的连接
V2NIMLoginService.getChatroomLinkAddress	获取聊天室 link 地址
V2NIMLoginService.getLoginUser	获取当前登录的用户账户 ID
V2NIMLoginService.getLoginStatus	获取当前登录状态
V2NIMLoginService.getConnectStatus	获取连接状态
V2NIMLoginService.getLoginClients	获取本账号的多端登录的其他端的信息
V2NIMLoginService.getKickedOfflineDetail	获取自己被踢下线的原因
V2NIMLoginService.setReconnectDelayProvider	设置断网重连的等待间隔函数

V2NIMLoginListener

V2NIMLoginService 的事件接口。调用示例: nim.V2NIMLoginService.on()。完整的 API 请参见 V2NIMLoginListener

事件名称	功能描述
V2NIMLoginListener.onLoginStatus	登录状态变更通知
V2NIMLoginListener.onLoginFailed	登录的鉴权失败通知
V2NIMLoginListener.onKickedOffline	被踢下线通知
V2NIMLoginListener.onLoginClientChanged	多端登陆通知
V2NIMLoginListener.onConnectStatus	连接状态变更
V2NIMLoginListener.onDisconnected	长连接断开
V2NIMLoginListener.onConnectFailed	连接建立失败
V2NIMLoginListener.onDataSync	数据同步完成的通知

V2NIMConversationService

挂载了会话相关 API。调用示例: nim.V2NIMConversationService.getConversationList。完整的 API 请参见 V2NIMConversationService

方法	功能描述
V2NIMConversationService.getConversationList	获取会话列表
V2NIMConversationService.getConversationListByOption	获取会话列表. 可以指定筛选条件，按会话类型，未读等
V2NIMConversationService.getConversation	根据会话 id 获取单条会话
V2NIMConversationService.getConversationListByIds	根据会话 id 获取会话列表
V2NIMConversationService.createConversation	创建会话
V2NIMConversationService.deleteConversation	删除会话
V2NIMConversationService.deleteConversationListByIds	批量删除会话
V2NIMConversationService.stickTopConversation	置顶会话
V2NIMConversationService.updateConversation	更新会话
V2NIMConversationService.updateConversationLocalExtension	更新会话的本地扩展字段
V2NIMConversationService.getTotalUnreadCount	获取全部会话的总的未读数
V2NIMConversationService.getUnreadCountByIds	根据 id 列表获取会话的未读数
V2NIMConversationService.getUnreadCountByFilter	根据过滤参数获取相应的未读信息
V2NIMConversationService.clearTotalUnreadCount	清空所有会话总的未读数
V2NIMConversationService.clearUnreadCountByIds	根据会话 id 列表清空相应会话的未读数
V2NIMConversationService.clearUnreadCountByTypes	清除对应指定类型下的会话的未读数
V2NIMConversationService.subscribeUnreadCountByFilter	订阅指定过滤条件的会话未读数变化
V2NIMConversationService.unsubscribeUnreadCountByFilter	取消订阅指定过滤条件的会话未读变化

V2NIMConversationListener

V2NIMConversationService 的事件接口。调用示例: nim.V2NIMConversationService.on()。完整的 API 请参见 V2NIMConversationListener

事件名称	功能描述
V2NIMConversationListener.onSyncStarted	会话模块的数据同步开始
V2NIMConversationListener.onSyncFinished	会话模块的数据同步结束
V2NIMConversationListener.onSyncFailed	会话模块的数据同步失败
V2NIMConversationListener.onConversationCreated	会话被创建
V2NIMConversationListener.onConversationDeleted	会话被删除
V2NIMConversationListener.onConversationChanged	会话有更新
V2NIMConversationListener.onTotalUnreadCountChanged	总未读数发生变化
V2NIMConversationListener.onUnreadCountChangedByFilter	指定过滤条件的未读数发生变化

V2NIMConversationGroupService

挂载了会话分组相关 API。调用示例: nim.V2NIMConversationGroupService.createConversationGroup。完整的 API 请参见 V2NIMConversationGroupService

方法	功能描述
V2NIMConversationGroupService.createConversationGroup	创建一个会话分组
V2NIMConversationGroupService.deleteConversationGroup	删除会话分组
V2NIMConversationGroupService.updateConversationGroup	更新会话分组
V2NIMConversationGroupService.addConversationsToGroup	添加会话到相应分组下面
V2NIMConversationGroupService.removeConversationsFromGroup	从会话分组删除相应会话
V2NIMConversationGroupService.getConversationGroup	获取单个会话分组信息
V2NIMConversationGroupService.getConversationGroupList	获取会话分组列表
V2NIMConversationGroupService.getConversationGroupListByIds	根据分组 ID 获取会话分组列表

V2NIMConversationGroupListener

V2NIMConversationGroupService 的事件接口。调用示例: nim.V2NIMConversationGroupService.on()。完整的 API 请参见 V2NIMConversationGroupListener

事件名称	功能描述
V2NIMConversationGroupListener.onConversationGroupCreated	会话分组被创建
V2NIMConversationGroupListener.onConversationGroupDeleted	会话分组被删除
V2NIMConversationGroupListener.onConversationGroupChanged	会话分组被更新
V2NIMConversationGroupListener.onConversationsAddedToGroup	会话分组下的会话被添加
V2NIMConversationGroupListener.onConversationsRemovedFromGroup	会话分组下的会话被删除

V2NIMMessageCreator

挂载了构造消息相关 API。调用示例: nim.V2NIMMessageCreator.createTextMessage。完整的 API 请参见 V2NIMMessageCreator

方法	功能描述
V2NIMMessageCreator.createTextMessage	构造文本消息
V2NIMMessageCreator.createImageMessage	构造图片消息
V2NIMMessageCreator.createAudioMessage	构造音频消息
V2NIMMessageCreator.createVideoMessage	构造视频消息
V2NIMMessageCreator.createFileMessage	构造文件消息
V2NIMMessageCreator.createLocationMessage	构造位置消息
V2NIMMessageCreator.createCustomMessage	构造自定义消息
V2NIMMessageCreator.createCallMessage	构造话单消息
V2NIMMessageCreator.createForwardMessage	构造提示消息

V2NIMMessageService

挂载消息相关 API。调用示例: nim.V2NIMMessageService.sendMessage。完整的 API 请参见 V2NIMMessageService

方法	功能描述
V2NIMMessageService.sendMessage	发送消息
V2NIMMessageService.replyMessage	回复消息
V2NIMMessageService.revokeMessage	撤回消息
V2NIMMessageService.getMessageList	查询历史消息
V2NIMMessageService.getMessageListByRefers	根据 MessageRefer 列表查询消息
V2NIMMessageService.deleteMessage	删除单条消息
V2NIMMessageService.deleteMessages	批量删除消息
V2NIMMessageService.clearHistoryMessage	清空会话历史消息
V2NIMMessageService.pinMessage	pin 一条消息
V2NIMMessageService.unpinMessage	取消一条 Pin 消息
V2NIMMessageService.updatePinMessage	更新一条 Pin 消息
V2NIMMessageService.getPinnedMessageList	获取 pin 消息列表
V2NIMMessageService.addQuickComment	添加快捷评论
V2NIMMessageService.removeQuickComment	移除快捷评论
V2NIMMessageService.getQuickCommentList	获取快捷评论列表
V2NIMMessageService.addCollection	添加一个收藏
V2NIMMessageService.removeCollections	移除相关收藏
V2NIMMessageService.updateCollectionExtension	更新收藏扩展字段
V2NIMMessageService.getCollectionListByOption	按条件分页获取收藏信息
V2NIMMessageService.sendP2PMessageReceipt	发送消息已读回执
V2NIMMessageService.getP2PMessageReceipt	查询点对点消息已读回执
V2NIMMessageService.isPeerRead	查询点对点消息是否对方已读
V2NIMMessageService.sendTeamMessageReceipts	发送群消息已读回执
V2NIMMessageService.getTeamMessageReceipts	获取群消息已读回执状态
V2NIMMessageService.getTeamMessageReceiptDetail	获取群消息已读回执状态详情
V2NIMMessageService.voiceToText	语音转文本
V2NIMMessageService.cancelMessageAttachmentUpload	取消文件类消息的附件上传
V2NIMMessageService.searchCloudMessages	检索云端的消息

V2NIMMessageListener

V2NIMMessageService 的事件接口。调用示例: nim.V2NIMMessageService.on()。完整的 API 请参见 V2NIMMessageListener

事件名称	功能描述
V2NIMMessageListener.onSendMessage	发送消息时，消息的状态变化回调
V2NIMMessageListener.onReceiveMessages	收到新消息
V2NIMMessageListener.onReceiveP2PMessageReadReceipts	收到点对点消息的已读回执
V2NIMMessageListener.onReceiveTeamMessageReadReceipts	收到高级群消息的已读回执
V2NIMMessageListener.onMessageRevokeNotifications	收到消息撤回回调
V2NIMMessageListener.onMessageDeletedNotifications	收到消息被删除通知
V2NIMMessageListener.onClearHistoryNotifications	清空会话历史消息通知
V2NIMMessageListener.onMessagePinNotification	收到消息 pin 状态更新
V2NIMMessageListener.onMessageQuickCommentNotification	收到消息快捷评论更新

V2NIMTeamService

群组相关 API。调用示例: nim.V2NIMTeamService.createTeam。完整的 API 请参见 V2NIMTeamService

方法	功能描述
V2NIMTeamService.createTeam	创建群组
V2NIMTeamService.updateTeamInfo	修改群组信息
V2NIMTeamService.leaveTeam	退出群组
V2NIMTeamService.getTeamInfo	获取群组信息
V2NIMTeamService.getJoinedTeamList	获取当前已经加入的群组列表
V2NIMTeamService.getJoinedTeamCount	获取当前已经加入的群组数量
V2NIMTeamService.getTeamInfoByIds	根据群组 ID 获取群组信息
V2NIMTeamService.dismissTeam	解散群组
V2NIMTeamService.inviteMember	邀请成员加入群
V2NIMTeamService.acceptInvitation	接受邀请入群
V2NIMTeamService.rejectInvitation	拒绝邀请入群
V2NIMTeamService.kickMember	踢出群组成员
V2NIMTeamService.applyJoinTeam	申请加入群组
V2NIMTeamService.acceptJoinApplication	(管理员)接受(用户的)入群申请
V2NIMTeamService.rejectJoinApplication	(管理员)拒绝(用户的)入群申请
V2NIMTeamService.updateTeamMemberRole	设置成员角色
V2NIMTeamService.transferTeamOwner	移交群主
V2NIMTeamService.updateSelfTeamMemberInfo	修改自己的群成员信息
V2NIMTeamService.updateTeamMemberNick	修改群成员昵称
V2NIMTeamService.setTeamChatBannedMode	设置群组禁言模式
V2NIMTeamService.setTeamMemberChatBannedStatus	设置群组成员聊天禁言状态
V2NIMTeamService.getTeamMemberList	获取群成员列表
V2NIMTeamService.getTeamMemberListByIds	根据账号 ID 列表获取群组成员列表
V2NIMTeamService.getTeamMemberInvitor	根据账号 ID 列表获取群组成员邀请人
V2NIMTeamService.getTeamJoinActionInfoList	获取群加入相关信息

V2NIMTeamListener

V2NIMTeamService 的事件接口。调用示例: nim.V2NIMTeamService.on()。完整的 API 请参见 V2NIMTeamListener

事件名称	功能描述
V2NIMTeamListener.onSyncStarted	群组信息同步开始回调
V2NIMTeamListener.onSyncFinished	群组信息同步结束回调
V2NIMTeamListener.onSyncFailed	群组信息数据同步失败
V2NIMTeamListener.onTeamCreated	群组创建回调
V2NIMTeamListener.onTeamDismissed	群组解散
V2NIMTeamListener.onTeamJoined	(自己)加入某群
V2NIMTeamListener.onTeamLeft	退出群组
V2NIMTeamListener.onTeamInfoUpdated	群组信息更新
V2NIMTeamListener.onTeamMemberJoined	群组成员加入
V2NIMTeamListener.onTeamMemberKicked	群组成员被踢
V2NIMTeamListener.onTeamMemberLeft	群组成员退出
V2NIMTeamListener.onTeamMemberInfoUpdated	群组成员信息变更
V2NIMTeamListener.onReceiveTeamJoinActionInfo	群组申请动作

V2NIMUserService

用户相关 API。调用示例: nim.V2NIMUserService.createTeam。完整的 API 请参见 V2NIMUserService

方法	功能描述
V2NIMUserService.getUserList	根据用户账号列表获取用户资料
V2NIMUserService.getUserListFromCloud	根据用户账号列表获取用户资料
V2NIMUserService.updateSelfUserProfile	更新自己的用户资料
V2NIMUserService.addUserToBlockList	添加用户到黑名单中
V2NIMUserService.removeUserFromBlockList	从黑名单中移除用户
V2NIMUserService.getBlockList	获取黑名单列表
V2NIMUserService.searchUserByOption	根据搜索条件搜索用户

V2NIMUserListener

V2NIMUserService 的事件接口。调用示例: nim.V2NIMUserService.on()。完整的 API 请参见 V2NIMUserListener

事件名称	功能描述
V2NIMUserListener.onUserProfileChanged	收到新消息
V2NIMUserListener.onBlockListAdded	黑名单添加通知
V2NIMUserListener.onBlockListRemoved	黑名单删除通知

V2NIMFriendService

好友相关 API。调用示例: nim.V2NIMFriendService.addFriend。完整的 API 请参见 V2NIMFriendService

方法	功能描述
V2NIMFriendService.addFriend	添加/申请好友
V2NIMFriendService.deleteFriend	删除好友
V2NIMFriendService.acceptAddApplication	接受好友申请
V2NIMFriendService.rejectAddApplication	添加/申请好友
V2NIMFriendService.setFriendInfo	设置好友信息
V2NIMFriendService.getFriendList	获取好友列表
V2NIMFriendService.checkFriend	根据账号 ID 检查好友状态
V2NIMFriendService.getAddApplicationList	获取申请添加好友列表通知
V2NIMFriendService.getAddApplicationUnreadCount	获取未读好友申请通知数量
V2NIMFriendService.setAddApplicationRead	设置所有好友申请已读
V2NIMFriendService.searchFriendByOption	根据搜索条件搜索好友

V2NIMFriendListener

V2NIMFriendService 的事件接口。调用示例: nim.V2NIMFriendService.on()。完整的 API 请参见 V2NIMFriendListener

事件名称	功能描述
V2NIMFriendListener.onFriendAdded	已添加好友
V2NIMFriendListener.onFriendDeleted	已删除好友
V2NIMFriendListener.onFriendAddApplication	收到好友申请
V2NIMFriendListener.onFriendAddRejected	好友申请被拒绝的通知
V2NIMFriendListener.onFriendInfoChanged	好友信息更新

V2NIMSettingService

设置相关 API。调用示例: nim.V2NIMSettingService.getConversationMuteStatus。完整的 API 请参见 V2NIMSettingService

方法	功能描述
V2NIMSettingService.getConversationMuteStatus	获取会话消息免打扰状态
V2NIMSettingService.setTeamMessageMuteMode	设置群消息免打扰模式
V2NIMSettingService.getTeamMessageMuteMode	获取群消息免打扰模式
V2NIMSettingService.setP2PMessageMuteMode	设置点对点消息免打扰模式
V2NIMSettingService.getP2PMessageMuteMode	获取用户消息免打扰模式
V2NIMSettingService.getP2PMessageMuteList	获取点对点消息免打扰列表
V2NIMSettingService.setAppBackground	设置应用前后台状态
V2NIMSettingService.setOfflinePushConfig	设置离线推送参数
V2NIMSettingService.setPushMobileOnDesktopOnline	设置当桌面端在线时，移动端是否需要推送

V2NIMSettingListener

V2NIMSettingService 的事件接口。调用示例: nim.V2NIMSettingService.on()。完整的 API 请参见 V2NIMSettingListener

事件名称	功能描述
V2NIMSettingListener.onTeamMessageMuteModeChanged	群消息免打扰模式变更
V2NIMSettingListener.onP2PMessageMuteModeChanged	点对点消息免打扰模式变更

V2NIMClientAntispamUtil

设置相关 API。调用示例: nim.V2NIMClientAntispamUtil.checkTextAntispam。完整的 API 请参见 V2NIMClientAntispamUtil

方法	功能描述
V2NIMClientAntispamUtil.checkTextAntispam	对输入的文本进行本地反垃圾检查

V2NIMStorageService

设置相关 API。调用示例: nim.V2NIMStorageService.addCustomStorageScene。完整的 API 请参见 V2NIMStorageService

方法	功能描述
V2NIMStorageService.addCustomStorageScene	设置自定义场景
V2NIMStorageService.getStorageSceneList	查询存储场景列表
V2NIMStorageService.createUploadFileTask	创建文件上传任务
V2NIMStorageService.uploadFile	上传文件
V2NIMStorageService.cancelUploadFile	取消文件上传
V2NIMStorageService.shortUrlToLong	短链转长链
[[V2NIMStorageService.imageThumbUrl]]	生成图片缩略链接
[[V2NIMStorageService.videoCoverUrl]]	生成视频封面图链接
V2NIMStorageService.getImageThumbUrl	获取图片缩略图 URL
V2NIMStorageService.getVideoCoverUrl	获取视频封面 URL

V2NIMNotificationService

通知相关 API。调用示例: nim.V2NIMNotificationService.sendCustomNotification。完整的 API 请参见 V2NIMNotificationService

方法	功能描述
V2NIMNotificationService.sendCustomNotification	发送自定义通知

V2NIMNotificationListener

V2NIMNotificationService 的事件接口。调用示例: nim.V2NIMNotificationService.on()。完整的 API 请参见 V2NIMNotificationListener

事件名称	功能描述
V2NIMNotificationListener.onReceiveCustomNotifications	收到自定义通知
V2NIMNotificationListener.onReceiveBroadcastNotifications	收到广播通知

DataStructureConverter

设置相关 API。调用示例: nim.DataStructureConverter.messageConvertToV1。完整的 API 请参见 DataStructureConverter

方法	功能描述
DataStructureConverter.messageConvertToV1	将 V2 消息转化为 V1 消息
DataStructureConverter.messageConvertToV2	将 V1 消息转化为 V2 消息

V2NIMMessageConverter

设置相关 API。调用示例: nim.V2NIMMessageConverter.messageSerialization。完整的 API 请参见 V2NIMMessageConverter

方法	功能描述
V2NIMMessageConverter.messageSerialization	将 V2 消息序列化
V2NIMMessageConverter.messageDeserialization	将 序列化消息反转成 V2 消息

V2NIMMessageConverter

设置相关 API。调用示例: nim.V2NIMAIService.getAIUserList。完整的 API 请参见 V2NIMAIService

方法	功能描述
V2NIMAIService.getAIUserList	将 V2 消息序列化
V2NIMAIService.proxyAIModelCall	将 序列化消息反转成 V2 消息

V2NIMMessageConverter

设置相关 API。调用示例: nim.V2NIMSignallingService.call。完整的 API 请参见 V2NIMSignallingService

方法	功能描述
V2NIMSignallingService.call	直接呼叫对方加入房间
V2NIMSignallingService.callSetup	呼叫建立
V2NIMSignallingService.createRoom	创建信令房间
V2NIMSignallingService.closeRoom	关闭信令房间接口
V2NIMSignallingService.joinRoom	加入信令房间接口
V2NIMSignallingService.leaveRoom	离开信令房间接口
V2NIMSignallingService.invite	邀请成员加入信令房间接口
V2NIMSignallingService.cancelInvite	取消之前的邀请成员加入信令房间接口
V2NIMSignallingService.rejectInvite	拒绝别人的邀请加入信令房间请求
V2NIMSignallingService.acceptInvite	接受别人的邀请加入信令房间请求
V2NIMSignallingService.sendControl	发送自定义控制指令
V2NIMSignallingService.getRoomInfoByChannelName	根据频道名称查询频道房间信息