群成员

群成员增删与退出；支持批量邀请与移除。

平台调用风格

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

接口一览

操作	语义	传输	返回
`getGroupMembers`	群成员列表（含角色/禁言）。	REST（客户端）	`GroupMember[]`
`addGroupMembers`	拉人入群（群主/管理员；普通成员按配置）。	REST（客户端）	`{added:string[], group:Group}`
`removeGroupMembers`	移除成员（群主/管理员；权限检查）。	REST（客户端）	`{removed:string[]}`
`quitGroup`	退出群；群主需先转让。	REST（客户端）	`null`

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

跨端方法名

操作	Android	Web	Electron	macOS	Flutter	Native (C ABI)	iOS
`getGroupMembers`	`getGroupMembers`	`getGroupMembers`	`getGroupMembers`	`getGroupMembers`	`getGroupMembers`	`im_client_group_members`	`func`
`addGroupMembers`	`addGroupMembers`	`addGroupMembers`	`addGroupMembers`	`addGroupMembers`	`addGroupMembers`	—	`func`
`removeGroupMembers`	`removeGroupMembers`	`removeGroupMembers`	`removeGroupMembers`	`removeGroupMembers`	`removeGroupMembers`	—	`func`
`quitGroup`	`quitGroup`	`quitGroup`	`quitGroup`	`quitGroup`	`quitGroup`	—	`func`

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

getGroupMembers

群成员列表（含角色/禁言）。

getGroupMembers(groupId)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`groupId`	`string`	必填；群组 ID

GroupMember[] 群成员列表

示例

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

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限
`1005`	`GROUP_NOT_FOUND`	客户端 / 参数 / 权限	404	否	群组不存在
`1006`	`NOT_GROUP_MEMBER`	客户端 / 参数 / 权限	403	否	未加入群组

addGroupMembers

拉人入群（群主/管理员；普通成员按配置）。

addGroupMembers(groupId, userIds)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`groupId`	`string`	必填；群组 ID
`userIds`	`string[]`	必填；用户 ID 列表（批量接口通常有上限）

{added:string[], group:Group} 成功返回的数据；失败时按错误码处理

示例

const res = await client.addGroupMembers('g_1001', ['user2']);
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限
`1004`	`USER_NOT_FOUND`	客户端 / 参数 / 权限	404	否	用户不存在
`1005`	`GROUP_NOT_FOUND`	客户端 / 参数 / 权限	404	否	群组不存在
`1015`	`MEMBERSHIP_LIMIT`	客户端 / 参数 / 权限	400	否	成员数量超出上限

removeGroupMembers

移除成员（群主/管理员；权限检查）。

removeGroupMembers(groupId, userIds)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`groupId`	`string`	必填；群组 ID
`userIds`	`string[]`	必填；用户 ID 列表（批量接口通常有上限）

{removed:string[]} 成功返回的数据；失败时按错误码处理

示例

const res = await client.removeGroupMembers('g_1001', ['user2']);
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限
`1005`	`GROUP_NOT_FOUND`	客户端 / 参数 / 权限	404	否	群组不存在
`1006`	`NOT_GROUP_MEMBER`	客户端 / 参数 / 权限	403	否	未加入群组

quitGroup

退出群；群主需先转让。

quitGroup(groupId)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`groupId`	`string`	必填；群组 ID

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

示例

await client.quitGroup('g_1001'); /* code === 0 为成功 */

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限
`1005`	`GROUP_NOT_FOUND`	客户端 / 参数 / 权限	404	否	群组不存在
`1006`	`NOT_GROUP_MEMBER`	客户端 / 参数 / 权限	403	否	未加入群组

群成员

接口一览​

跨端方法名​

getGroupMembers​

addGroupMembers​

removeGroupMembers​

quitGroup​

相关文档​

接口一览

跨端方法名

getGroupMembers

addGroupMembers

removeGroupMembers

quitGroup

相关文档