群成员

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

平台调用风格

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

接口一览​

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

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getGroupMembersgetGroupMembersgetGroupMembersgetGroupMembersgetGroupMembersgetGroupMembersim_client_group_membersfunc
addGroupMembersaddGroupMembersaddGroupMembersaddGroupMembersaddGroupMembersaddGroupMembers—func
removeGroupMembersremoveGroupMembersremoveGroupMembersremoveGroupMembersremoveGroupMembersremoveGroupMembers—func
quitGroupquitGroupquitGroupquitGroupquitGroupquitGroup—func

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

getGroupMembers​

群成员列表(含角色/禁言)。

im_client_group_members(im_client_t*, const char* group_id, char** out_json)
REST(客户端)since 1.0.0
参数
参数类型说明
groupIdstring必填;群组 ID
返回

GroupMember[] 群成员列表

示例
C
char* members_json = NULL;
int rc = im_client_group_members(client, "g_1001", &members_json);
if (rc == 0) { /* 解析 members_json */ }
im_string_free(members_json);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1005GROUP_NOT_FOUND客户端 / 参数 / 权限404否群组不存在
1006NOT_GROUP_MEMBER客户端 / 参数 / 权限403否未加入群组

addGroupMembers​

拉人入群(群主/管理员;普通成员按配置)。

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

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

参数
参数类型说明
groupIdstring必填;群组 ID
userIdsstring[]必填;用户 ID 列表(批量接口通常有上限)
返回

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

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

removeGroupMembers​

移除成员(群主/管理员;权限检查)。

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

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

参数
参数类型说明
groupIdstring必填;群组 ID
userIdsstring[]必填;用户 ID 列表(批量接口通常有上限)
返回

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

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

quitGroup​

退出群;群主需先转让。

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

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

参数
参数类型说明
groupIdstring必填;群组 ID
返回

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

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

相关文档​