跳到主要内容

查询聊天室房间信息

获取聊天室的信息,可返回以下数据:

  • 聊天室成员总数
  • 指定数量(最多 20 个)的聊天室成员的列表,包括该成员的用户 ID 以及加入聊天室的时间
提示

频率限制:单个设备每秒钟支持调用一次,每分钟单个设备最多调用 20 次。

调用 getChatRoomInfo 方法,可获取聊天室的信息。

接口

JavaScript
RongIMLib.getChatRoomInfo(chatRoomId, options)

参数说明

参数类型必填说明
chatRoomIdstring聊天室 ID
optionsobject可选参数
  • options 说明
参数类型必填说明
countnumber获取聊天室的人数,传值范围:0-20,默认为 0
orderstring按照何种顺序返回聊天室成员信息,默认为 0 不返回,升序(1)返回最早加入的用户列表。降序(2)返回最晚加入的用户列表。
提示
  • count 或 order 有一个为 0 时,只返回成员总数,不返回成员列表信息, order 人员排序方式,1 为正序,2 为倒序,默认为 0 不返回
  • 单个设备每秒钟支持调用一次,每分钟单个设备最多调用 20 次

示例代码

JavaScript
const chatroomId = "<聊天室 ID>"
const count = 10 // 获取房间人员列表数量,最大有效值 `20`,最小值为 `0`,默认为 0
const order = 1 // 人员排序方式,`1` 为正序,`2` 为倒序,默认为 0
RongIMLib.getChatRoomInfo(chatRoomId, {
count: count,
order: order
}).then(res => {
// 获取聊天室信息成功
if(res.code === 0){
console.log(res.data)
} else {
console.log(res.code, res.data)
}
})