创建群组

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

平台调用风格

回调式(callback-last):有返回数据用 ResultCallback<T>,无返回数据用 OperationCallback;所有回调在主线程投递。

接口一览​

操作语义传输返回
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 可由调用方指定(唯一)或服务端生成。

createGroup(name: String, memberIds: List<String>, options: GroupOptions? = null, callback: ResultCallback<Group>)
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 群资料

示例
Kotlin
client.createGroup(
    name = "产品群",
    memberIds = "value",
    callback = object : ResultCallback<Group> {
        override fun onSuccess(result: Group) { /* 处理返回数据 */ }
        override fun onError(error: IMError) { /* 处理 error.code */ }
    },
)
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在
1015MEMBERSHIP_LIMIT客户端 / 参数 / 权限400否成员数量超出上限
1021SERVICE_NOT_ACTIVATEDOpen API 签名与开通403否服务未开通

getGroupsInfo​

批量查询群信息(<=20)。

getGroupsInfo(groupIds: List<String>, callback: ResultCallback<List<Group>>)
REST(客户端)since 1.0.0
参数
参数类型说明
groupIdsstring[]必填;群组 ID 列表
返回

Group[] 群资料列表

示例
Kotlin
client.getGroupsInfo(
    groupIds = listOf("g_1001"),
    callback = object : ResultCallback<List<Group>> {
        override fun onSuccess(result: List<Group>) { /* 处理返回数据 */ }
        override fun onError(error: IMError) { /* 处理 error.code */ }
    },
)
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误

相关文档​