创建群组

创建普通群与查询群资料；群成员上限 3000，超出请使用超级群。

平台调用风格

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

接口一览​

操作语义传输返回
createGroup创建群（groupType 缺省 normal；joinPolicy 缺省 open；maxMembers 对 super 有效）。groupId 可由调用方指定（唯一）或服务端生成。REST（客户端）Group
getGroupsInfo批量查询群信息（<=20）。REST（客户端）Group[]

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
createGroupcreateGroupcreateGroupcreateGroupcreateGroupcreateGroup—func
getGroupsInfogetGroupsInfogetGroupsInfogetGroupsInfogetGroupsInfogetGroupsInfo—func

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

createGroup​

创建群（groupType 缺省 normal；joinPolicy 缺省 open；maxMembers 对 super 有效）。groupId 可由调用方指定（唯一）或服务端生成。

func createGroup(_ options: IMPCreateGroupOptions) async -> RcResult<IMPGroup>
REST（客户端）since 1.0.0
参数
参数类型说明
options{groupId?:string, name:string, owner?:string, members?:string[], groupType?:GroupType, joinPolicy?:JoinPolicy, maxMembers?:int}必填；选项对象（字段见类型列）：{ groupId?:string, name:string, owner?:string, members?:string[], groupType?:GroupType, joinPolicy?:JoinPolicy, maxMembers?:int }
返回

Group 群资料

示例（Swift / Objective-C）​

let res = await client.createGroup(IMPCreateGroupOptions(name: "产品群"))
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client createGroupWithOptions:@{ @"groupId": @"g_1001", @"name": @"产品群", @"owner": @"user2", @"members": @[@"user2"], @"groupType": @"normal", @"joinPolicy": @"open", @"maxMembers": @0 } 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否用户不存在
1015MEMBERSHIP_LIMIT客户端 / 参数 / 权限400否成员数量超出上限
1021SERVICE_NOT_ACTIVATEDOpen API 签名与开通403否服务未开通

getGroupsInfo​

批量查询群信息（<=20）。

func getGroupsInfo(groupIds: [String]) async -> RcResult<[IMPGroup]>
REST（客户端）since 1.0.0
参数
参数类型说明
groupIdsstring[]必填；群组 ID 列表
返回

Group[] 群资料列表

示例（Swift / Objective-C）​

let res = await client.getGroupsInfo(groupIds: ["g_1001"])
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client getGroupsInfoWithGroupIds:@[@"g_1001"] completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败：%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误

相关文档​