创建群组
创建普通群与查询群资料;群成员上限 3000,超出请使用超级群。
平台调用风格
回调式(callback-last):有返回数据用 ResultCallback<T>,无返回数据用 OperationCallback;所有回调在主线程投递。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
createGroup | 创建群(groupType 缺省 normal;joinPolicy 缺省 open;maxMembers 对 super 有效)。groupId 可由调用方指定(唯一)或服务端生成。 | REST(客户端) | Group |
getGroupsInfo | 批量查询群信息(<=20)。 | REST(客户端) | Group[] |
本页 2 个操作,其中 2 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
createGroup | createGroup | createGroup | createGroup | createGroup | createGroup | — | func |
getGroupsInfo | getGroupsInfo | getGroupsInfo | getGroupsInfo | getGroupsInfo | getGroupsInfo | — | 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>)参数
| 参数 | 类型 | 说明 |
|---|---|---|
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 | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
1015 | MEMBERSHIP_LIMIT | 客户端 / 参数 / 权限 | 400 | 否 | 成员数量超出上限 |
1021 | SERVICE_NOT_ACTIVATED | Open API 签名与开通 | 403 | 否 | 服务未开通 |
getGroupsInfo
批量查询群信息(<=20)。
getGroupsInfo(groupIds: List<String>, callback: ResultCallback<List<Group>>)参数
| 参数 | 类型 | 说明 |
|---|---|---|
groupIds | string[] | 必填;群组 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 | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南