聊天室信息

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

平台调用风格

C ABI 约定:im_client_* 返回 int(0 成功,非 0 为 IDL 错误码);char** out_json 由库分配、调用方用 im_string_free 释放;char* out + size_t cap 为调用方缓冲区(0 成功 / -1 参数非法 / -2 缓冲区不足)。

接口一览​

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

本页 2 个操作,其中 1 个在本平台绑定中声明了方法签名,其余为 C ABI 未暴露(见对应小节)。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getChatroomInfogetChatroomInfogetChatroomInfogetChatroomInfogetChatroomInfogetChatroomInfoim_client_chatroom_infofunc
getChatroomMembersgetChatroomMembersgetChatroomMembersgetChatroomMembersgetChatroomMembersgetChatroomMembers—func

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

getChatroomInfo​

聊天室信息(含在线数)。

im_client_chatroom_info(im_client_t*, const char* chatroom_id, char** out_json)
REST(客户端)since 1.0.0
参数
参数类型说明
chatroomIdstring必填;聊天室 ID
返回

Chatroom 聊天室资料

示例
C
char* chatroom_json = NULL;
int rc = im_client_chatroom_info(client, "cr_2001", &chatroom_json);
if (rc == 0) { /* 解析 chatroom_json */ }
im_string_free(chatroom_json);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1012CHATROOM_NOT_FOUND客户端 / 参数 / 权限404否聊天室不存在

getChatroomMembers​

聊天室在线成员列表。

本平台 C ABI 未暴露该方法
REST(客户端)since 1.0.0

本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。

参数
参数类型说明
chatroomIdstring必填;聊天室 ID
options{offset?:uint32,limit?:uint32}可选;选项对象(字段见类型列):{ offset?:uint32, limit?:uint32 }
返回

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

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

相关文档​