群管理
群主与管理员可修改群资料、转让群主、设置管理员与成员禁言。
C ABI 约定:im_client_* 返回 int(0 成功,非 0 为 IDL 错误码);char** out_json 由库分配、调用方用 im_string_free 释放;char* out + size_t cap 为调用方缓冲区(0 成功 / -1 参数非法 / -2 缓冲区不足)。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
updateGroupName | 修改群名(群主/管理员)。 | REST(客户端) | Group |
updateGroupNotice | 设置群公告(群主/管理员,<=500 字,空串清除)。 | REST(客户端) | Group |
transferGroupOwner | 转让群主(新群主须为成员)。 | REST(客户端) | Group |
addGroupAdmin | 设置管理员(群主,幂等)。 | REST(客户端) | Group |
removeGroupAdmin | 取消管理员(群主)。 | REST(客户端) | Group |
muteGroupMember | 禁言/解禁(群主/管理员;不能禁言群主;管理员不能禁言管理员)。 | REST(客户端) | {groupId:string,userId:string,mutedUntil:uint64,group:Group} |
本页 6 个操作,其中 0 个在本平台绑定中声明了方法签名,其余为 C ABI 未暴露(见对应小节)。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
updateGroupName | updateGroupName | updateGroupName | updateGroupName | updateGroupName | updateGroupName | — | func |
updateGroupNotice | updateGroupNotice | updateGroupNotice | updateGroupNotice | updateGroupNotice | updateGroupNotice | — | func |
transferGroupOwner | transferGroupOwner | transferGroupOwner | transferGroupOwner | transferGroupOwner | transferGroupOwner | — | func |
addGroupAdmin | addGroupAdmin | addGroupAdmin | addGroupAdmin | addGroupAdmin | addGroupAdmin | — | func |
removeGroupAdmin | removeGroupAdmin | removeGroupAdmin | removeGroupAdmin | removeGroupAdmin | removeGroupAdmin | — | func |
muteGroupMember | muteGroupMember | muteGroupMember | muteGroupMember | muteGroupMember | muteGroupMember | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
本页操作均未在正式 C ABI(include/im_sdk.h)中暴露。C ABI 当前覆盖 18 个操作:init / connect / disconnect / getConnectionStatus / getCurrentUserId / sendTextMessage / sendMessage / recallMessage / sendReadReceipt / getConversationList / getHistoryMessages / getGroupMembers / joinChatroom / leaveChatroom / getChatroomInfo / uploadFile / addEventListener / removeEventListener。其余能力请使用其它平台绑定,或通过服务端 Open API 完成。
| 替代路径 | 说明 |
|---|---|
| 服务端 Open API | 群组模块接口:在服务端批量管理消息、会话、群组与用户 |
| Web / Electron / Flutter / Android 绑定 | 这些绑定覆盖全部 62 个语义 op;可通过服务端中转或由另一进程执行后回调 Native 侧 |
updateGroupName
修改群名(群主/管理员)。
本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
name | string | 必填;名称(群名 / 聊天室名 / 文件名) |
Group 群资料
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
updateGroupNotice
设置群公告(群主/管理员,<=500 字,空串清除)。
本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
notice | string | 必填;群公告文本(<=500 字,空串清除) |
Group 群资料
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
transferGroupOwner
转让群主(新群主须为成员)。
本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
newOwner | string | 必填;新群主用户 ID(必须是群成员) |
Group 群资料
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
addGroupAdmin
设置管理员(群主,幂等)。
本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
userId | string | 必填;用户 ID |
Group 群资料
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
removeGroupAdmin
取消管理员(群主)。
本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
userId | string | 必填;用户 ID |
Group 群资料
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
muteGroupMember
禁言/解禁(群主/管理员;不能禁言群主;管理员不能禁言管理员)。
本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
userId | string | 必填;用户 ID |
mutedUntil | uint64 | 必填;禁言到期时间(epoch 毫秒;0 表示解除禁言) |
{groupId:string,userId:string,mutedUntil:uint64,group:Group} 成功返回的数据;失败时按错误码处理
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
1006 | NOT_GROUP_MEMBER | 客户端 / 参数 / 权限 | 403 | 否 | 未加入群组 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南