聊天室信息

获取聊天室资料与在线成员列表；成员数不设上限。

平台调用风格

异步风格：Promise<RcResult<T>>（{ code, data?, msg? }）；业务错误通过 res.code !== 0 判断，不抛异常。

接口一览

操作	语义	传输	返回
`getChatroomInfo`	聊天室信息（含在线数）。	REST（客户端）	`Chatroom`
`getChatroomMembers`	聊天室在线成员列表。	REST（客户端）	`{members:ChatroomMember[], total:uint32}`

本页 2 个操作，其中 2 个在本平台绑定中声明了方法签名。

操作	Android	Web	Electron	macOS	Flutter	Native (C ABI)	iOS
`getChatroomInfo`	`getChatroomInfo`	`getChatroomInfo`	`getChatroomInfo`	`getChatroomInfo`	`getChatroomInfo`	`im_client_chatroom_info`	`func`
`getChatroomMembers`	`getChatroomMembers`	`getChatroomMembers`	`getChatroomMembers`	`getChatroomMembers`	`getChatroomMembers`	—	`func`

方法名在 GA 平台之间保持一致（规则 A）；Native C ABI 只覆盖部分操作，其余操作以 — 标注。

聊天室信息（含在线数）。

getChatroomInfo(chatroomId)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`chatroomId`	`string`	必填；聊天室 ID

Chatroom 聊天室资料

示例

const res = await client.getChatroomInfo('cr_2001');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1012`	`CHATROOM_NOT_FOUND`	客户端 / 参数 / 权限	404	否	聊天室不存在

聊天室在线成员列表。

getChatroomMembers(chatroomId, options?)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`chatroomId`	`string`	必填；聊天室 ID
`options`	`{offset?:uint32,limit?:uint32}`	可选；选项对象（字段见类型列）：{ offset?:uint32, limit?:uint32 }

{members:ChatroomMember[], total:uint32} 在线成员页与总数

示例

const res = await client.getChatroomMembers('cr_2001');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1012`	`CHATROOM_NOT_FOUND`	客户端 / 参数 / 权限	404	否	聊天室不存在