WebIM JS SDK API 文档

更新时间：2020-05-08

初始化WebIM

new WebIM({appId, appKey, [autoConnect], environment, socketUrl, timeout})

Param	Type	Default	Description
appId	string		appId
appKey	string		appKey
[autoConnect]	boolean	true	设置是否自动重连
environment	development | production		环境变量
socketUrl	socketUrl		socket 地址
timeout	number		超时时间

登录

WebIM.login(userId, token) ⇒ Promise.<{userId: string, unreadMsgCount: number}>

Kind: instance method of WebIM

Param	Type	Description
userId	string	用户ID
token	string	验证token

登出

WebIM.logout() ⇒ void

Kind: instance method of WebIM

群组部分

GroupManager Kind: global class

• GroupManager
  • new GroupManager()
  • instance
    • .create(groupName) ⇒ void
    • .query(groupId) ⇒ object
    • .update(groupId, groupName) ⇒ void
    • .delete(groupId) ⇒ void
    • .join(groupId, [userName]) ⇒ void
    • .leave(groupId) ⇒ void
    • .transfer(groupId, ownerId) ⇒ void
    • .getUserList(groupId) ⇒ object
    • .getUserGroupList([pageIndex], [pageSize]) ⇒ object
    • .gag(groupId, from, touid, type) ⇒ void
    • .allGag(groupId, from, type) ⇒ object
    • .blockUser(groupId, from, touid, time) ⇒ void
    • .unBlockUser(groupId, from) ⇒ void
    • .sendMessage(groupId, content) ⇒ void
    • .sendAck(received) ⇒ void
  • static
    • "message" ⇒ object
    • "groupjoin" ⇒ object
    • "groupexit" ⇒ object
    • "groupadmin" ⇒ object
    • "groupgag" ⇒ object
    • "groupallgag" ⇒ object
    • "groupdissolve" ⇒ object
    • "groupdissolve" ⇒ object

创建群组

groupManager.create(groupName) ⇒ void

Kind: instance method of GroupManager
Returns: void - {Promise<{groupId: string}>}

Param	Type	Description
groupName	string	群组名称

查询群组

groupManager.query(groupId) ⇒ object

Kind: instance method of GroupManager
Returns: object - {Promise<{groupId: string, groupName: string, ownerId: string}>}

Param	Type	Description
groupId	string	群组ID

更新群组

groupManager.update(groupId, groupName) ⇒ void

Kind: instance method of GroupManager
Returns: void - - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID
groupName	string	群组名称

删除群组

groupManager.delete(groupId) ⇒ void

Kind: instance method of GroupManager
Returns: void - - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID

加入群组

groupManager.join(groupId, [userName]) ⇒ void

Kind: instance method of GroupManager
Returns: void - - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID
[userName]	string	用户名

离开群组

groupManager.leave(groupId) ⇒ void

Kind: instance method of GroupManager
Returns: void - - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID

变更群主

groupManager.transfer(groupId, ownerId) ⇒ void

Kind: instance method of GroupManager
Returns: void - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID
ownerId	string	群主ID

获取群组中所有用户列表

groupManager.getUserList(groupId) ⇒ object

Kind: instance method of GroupManager
Returns: object - {Promise<[{userId:string,userName:string,role:number}]>}

Param	Type	Description
groupId	string	群组ID

获取用户群组列表

groupManager.getUserGroupList([pageIndex], [pageSize]) ⇒ object

Kind: instance method of GroupManager
Returns: object - {Promise<[{groupId:string,groupName:string,ownerId:string}]>}

Param	Type	Default
[pageIndex]	number	1
[pageSize]	number	-1

群个人禁言

groupManager.gag(groupId, from, touid, type) ⇒ void

Kind: instance method of GroupManager
Returns: void - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID
from	string	群主 ID
touid	string
type	number	0 解除禁言 1禁言

群全体禁言

groupManager.allGag(groupId, from, type) ⇒ object

Kind: instance method of GroupManager
Returns: object - {Promise<[{groupId:string,groupName:string,ownerId:string}]>}

Param	Type	Description
groupId	string	群组ID
from	string	群主ID
type	number	0 解除禁言 1 禁言

群拉黑

groupManager.blockUser(groupId, from, touid, time) ⇒ void

Kind: instance method of GroupManager
Returns: void - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID
from	string	群主 ID
touid	string	拉黑人员多个以逗号分隔
time	string	拉黑时长，分钟为单位。-99永远

群解除拉黑

groupManager.unBlockUser(groupId, from) ⇒ void

Kind: instance method of GroupManager
Returns: void - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID
from	string	群主 id

发送群组消息

groupManager.sendMessage(groupId, content) ⇒ void

Kind: instance method of GroupManager
Returns: void - {Promise\<void>}

Param	Type	Description
groupId	string	群组ID
content	string	消息内容

发送接收反馈

groupManager.sendAck(received) ⇒ void

Kind: instance method of GroupManager
Returns: void - {Promise\<void>}

Param	Type	Description
received	array.<{from: string, to: string, content: string}>	接收消息列表

获取群组消息 event

"message" ⇒ object

Kind: event emitted by GroupManager
Returns: object - {{from: string, to: string, content: string}}

获取加入群组通知 event

"groupjoin" ⇒ object

Kind: event emitted by GroupManager
Returns: object - {{content: string(userId)}}

获取退出群组通知 event

"groupexit" ⇒ object

Kind: event emitted by GroupManager
Returns: object - {{content: string(userId)}}

获取群组变更管理员通知 event

"groupadmin" ⇒ object

Kind: event emitted by GroupManager
Returns: object - {{content: string(变更后管理员 userId)}}

获取群组个人禁言通知 event

"groupgag" ⇒ object

Kind: event emitted by GroupManager
Returns: object - {{content: string(被禁人员 userId), gagstatus: 0解除禁言 1禁言}}

获取群组全体禁言通知 event

"groupallgag" ⇒ object

Kind: event emitted by GroupManager
Returns: object - {{content: string(群id), gagstatus: 0解除禁言 1禁言}}

获取群组解散通知 event

"groupdissolve" ⇒ object

Kind: event emitted by GroupManager
Returns: object - {{ content: string(群id)}}

获取群组踢出成员通知 event

"groupdissolve" ⇒ object

Kind: event emitted by GroupManager
Returns: object - {{content: string(被踢用户 userId)}}

直播间部分

LiveroomManager Kind: global class

• LiveroomManager
  • new LiveroomManager()
  • instance
    • .create(roomId) ⇒ void
    • .join(roomId) ⇒ void
    • .leave(roomId) ⇒ void
    • .mute(roomId, userId) ⇒ void
    • .unmute(roomId, userId) ⇒ void
    • .muteAll(roomId) ⇒ void
    • .unmuteAll(roomId) ⇒ void
    • .sendMessage(roomId, content) ⇒ void
  • static
    • "create" ⇒ object
    • "join" ⇒ object
    • "leave" ⇒ object
    • "message" ⇒ object

创建房间

liveroomManager.create(roomId) ⇒ void

Kind: instance method of LiveroomManager
Returns: void - {Promise\<void>}

Param	Type	Description
roomId	string	房间ID

加入房间

liveroomManager.join(roomId) ⇒ void

Kind: instance method of LiveroomManager
Returns: void - {Promise\<void>}

Param	Type	Description
roomId	string	房间ID

离开房间

liveroomManager.leave(roomId) ⇒ void

Kind: instance method of LiveroomManager
Returns: void - {Promise\<void>}

Param	Type	Description
roomId	string	房间ID

用户静音

liveroomManager.mute(roomId, userId) ⇒ void

Kind: instance method of LiveroomManager
Returns: void - {Promise\<void>}

Param	Type	Description
roomId	string	房间ID
userId	string	用户ID

用户取消静音

liveroomManager.unmute(roomId, userId) ⇒ void

Kind: instance method of LiveroomManager
Returns: void - {Promise\<void>}

Param	Type	Description
roomId	string	房间ID
userId	string	用户ID

房间静音

liveroomManager.muteAll(roomId) ⇒ void

Kind: instance method of LiveroomManager
Returns: void - {Promise\<void>}

Param	Type	Description
roomId	string	房间ID

房间取消静音

liveroomManager.unmuteAll(roomId) ⇒ void

Kind: instance method of LiveroomManager
Returns: void - {Promise\<void>}

Param	Type	Description
roomId	string	房间ID

发送直播间消息

liveroomManager.sendMessage(roomId, content) ⇒ void

Kind: instance method of LiveroomManager
Returns: void - {Promise\<void>}

Param	Type	Description
roomId	string	房间ID
content	string	消息内容

获取创建直播间消息 event

"create" ⇒ object

Kind: event emitted by LiveroomManager
Returns: object - {{roomId: string, userId: string}}

获取加入直播间消息 event

"join" ⇒ object

Kind: event emitted by LiveroomManager
Returns: object - {{roomId: string, userId: string}}

获取离开直播间消息 event

"leave" ⇒ object

Kind: event emitted by LiveroomManager
Returns: object - {{roomId: string, userId: string}}

获取直播间实时消息 event

"message" ⇒ object

Kind: event emitted by LiveroomManager
Returns: object - {{from: string, to: string, content: string}}

私信部分

PersonalManager Kind: global class

• PersonalManager
  • new PersonalManager()
  • instance
    • .sendMessage(userId, content) ⇒ void
    • .sendAck(received) ⇒ void
  • static
    • "message" ⇒ object

发送私信

personalManager.sendMessage(userId, content) ⇒ void

Kind: instance method of PersonalManager
Returns: void - {Promise\<void>}

Param	Type	Description
userId	string	用户ID
content	string	消息内容

发送接收反馈

personalManager.sendAck(received) ⇒ void

Kind: instance method of PersonalManager
Returns: void - {Promise\<void>}

Param	Type
received	Array.<TextMsgDataWrapper>

获取私信消息 event

"message" ⇒ object

Kind: event emitted by PersonalManager
Returns: object - {{from: string, to: string, content: string}}

获取未读消息列表

pullManager.getUnreadMessageList([sequenceId], [totalSize]) ⇒ object

Kind: instance method of PullManager
Returns: object - {Promise<[type: string, message: string]>}

Param	Type	Default
[sequenceId]	number | Long	0
[totalSize]	number	-1

获取错误消息 event

"error" ⇒ object

Kind: event emitted
Returns: object - {type: number, data: any, error: string}