加入与退出

聊天室只有在线用户可收发消息；加入后最多获取最近 50 条消息。

平台调用风格

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

接口一览

操作	语义	传输	返回
`createChatroom`	创建聊天室（客户端能力；服务端 Open API 亦可创建）。chatroomId 可指定或服务端生成。	REST（客户端）	`Chatroom`
`joinChatroom`	加入聊天室：发送 chatroom_join，收到 chatroom_joined；房内广播 member_changed。	WS 长连接	`Chatroom`
`leaveChatroom`	离开聊天室。	WS 长连接	`null`

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

跨端方法名

操作	Android	Web	Electron	macOS	Flutter	Native (C ABI)	iOS
`createChatroom`	`createChatroom`	`createChatroom`	`createChatroom`	`createChatroom`	`createChatroom`	—	`func`
`joinChatroom`	`joinChatroom`	`joinChatroom`	`joinChatroom`	`joinChatroom`	`joinChatroom`	`im_client_chatroom_join`	`func`
`leaveChatroom`	`leaveChatroom`	`leaveChatroom`	`leaveChatroom`	`leaveChatroom`	`leaveChatroom`	`im_client_chatroom_leave`	`func`

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

createChatroom

创建聊天室（客户端能力；服务端 Open API 亦可创建）。chatroomId 可指定或服务端生成。

createChatroom({chatroomId?, name, owner?})

REST（客户端）since 1.0.0

参数

参数	类型	说明
`options`	`{chatroomId?:string, name:string, owner?:string}`	必填；选项对象（字段见类型列）：{ chatroomId?:string, name:string, owner?:string }

Chatroom 聊天室资料

示例

const res = await client.createChatroom({ name: '产品群' });
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限
`1015`	`MEMBERSHIP_LIMIT`	客户端 / 参数 / 权限	400	否	成员数量超出上限
`1021`	`SERVICE_NOT_ACTIVATED`	Open API 签名与开通	403	否	服务未开通

joinChatroom

加入聊天室：发送 chatroom_join，收到 chatroom_joined；房内广播 member_changed。

joinChatroom(chatroomId)

WS 长连接幂等since 1.0.0

参数

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

Chatroom 聊天室资料

示例

const res = await client.joinChatroom('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	否	聊天室不存在
`1013`	`CHATROOM_CLOSED`	客户端 / 参数 / 权限	410	否	聊天室已销毁
`3001`	`SDK_NOT_CONNECTED`	SDK 本地	0	是	长连接未就绪

leaveChatroom

离开聊天室。

leaveChatroom(chatroomId)

WS 长连接幂等since 1.0.0

参数

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

null 无返回数据；成功与否通过错误码判断

示例

await client.leaveChatroom('cr_2001'); /* code === 0 为成功 */

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1012`	`CHATROOM_NOT_FOUND`	客户端 / 参数 / 权限	404	否	聊天室不存在
`3001`	`SDK_NOT_CONNECTED`	SDK 本地	0	是	长连接未就绪

加入与退出

接口一览​

跨端方法名​

createChatroom​

joinChatroom​

leaveChatroom​

相关文档​

接口一览

跨端方法名

createChatroom

joinChatroom

leaveChatroom

相关文档