群成员

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

平台调用风格

双语言同契约:Swift 用 async -> RcResult<T>(错误码在 RcResult.code,返回 null 的 op 用 RcResult<Void>);Objective-C 用 - (void)opWithParam:... completion:(void (^)(RcResult *))completion,回调在主线程投递。

接口一览​

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

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

跨端方法名​

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

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

getGroupMembers​

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

func getGroupMembers(groupId: String) async -> RcResult<[IMPGroupMember]>
REST(客户端)since 1.0.0
参数
参数类型说明
groupIdstring必填;群组 ID
返回

GroupMember[] 群成员列表

示例(Swift / Objective-C)​

let res = await client.getGroupMembers(groupId: "g_1001")
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }
[client getGroupMembersWithGroupId:@"g_1001" completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1005GROUP_NOT_FOUND客户端 / 参数 / 权限404否群组不存在
1006NOT_GROUP_MEMBER客户端 / 参数 / 权限403否未加入群组

addGroupMembers​

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

func addGroupMembers(groupId: String, userIds: [String]) async -> RcResult<IMPAddGroupMembersResult>
REST(客户端)since 1.0.0
参数
参数类型说明
groupIdstring必填;群组 ID
userIdsstring[]必填;用户 ID 列表(批量接口通常有上限)
返回

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

示例(Swift / Objective-C)​

let res = await client.addGroupMembers(groupId: "g_1001", userIds: ["user2"])
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }
[client addGroupMembersWithGroupId:@"g_1001" userIds:@[@"user2"] completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在
1005GROUP_NOT_FOUND客户端 / 参数 / 权限404否群组不存在
1015MEMBERSHIP_LIMIT客户端 / 参数 / 权限400否成员数量超出上限

removeGroupMembers​

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

func removeGroupMembers(groupId: String, userIds: [String]) async -> RcResult<IMPRemoveGroupMembersResult>
REST(客户端)since 1.0.0
参数
参数类型说明
groupIdstring必填;群组 ID
userIdsstring[]必填;用户 ID 列表(批量接口通常有上限)
返回

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

示例(Swift / Objective-C)​

let res = await client.removeGroupMembers(groupId: "g_1001", userIds: ["user2"])
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }
[client removeGroupMembersWithGroupId:@"g_1001" userIds:@[@"user2"] completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1005GROUP_NOT_FOUND客户端 / 参数 / 权限404否群组不存在
1006NOT_GROUP_MEMBER客户端 / 参数 / 权限403否未加入群组

quitGroup​

退出群;群主需先转让。

func quitGroup(groupId: String) async -> RcResult<Void>
REST(客户端)since 1.0.0
参数
参数类型说明
groupIdstring必填;群组 ID
返回

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

示例(Swift / Objective-C)​

let res = await client.quitGroup(groupId: "g_1001")
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }
[client quitGroupWithGroupId:@"g_1001" completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1005GROUP_NOT_FOUND客户端 / 参数 / 权限404否群组不存在
1006NOT_GROUP_MEMBER客户端 / 参数 / 权限403否未加入群组

相关文档​