设置群成员角色
描述
调用此接口,可以为群成员设置在群内的角色。
ZIM SDK 默认支持将用户设置为群主、管理员、普通成员。在群组中,群主拥有所有客户端权限,可以实现所有群组功能。管理员拥有大部分客户端权限。普通成员拥有的客户端权限最少,具体如下表所示:
客户端权限 | 群主(对应枚举值为 1) | 管理员(对应枚举值为 2) | 普通成员(对应枚举值为 3) |
---|---|---|---|
修改群头像、群名称、群公告 | 支持 | 支持 | 支持 |
修改群属性 | |||
修改群成员昵称 | 支持,可对所有群角色用户使用此功能 | 支持,可对所有普通成员使用此功能 | 支持,仅可对自己使用此功能 |
撤回群成员消息 | |||
踢人 | 不支持。 | ||
对单独群成员禁言 | |||
对特定群角色禁言 | |||
设置群成员角色 | 不支持 | ||
转让群主 | |||
解散群组 | |||
全员禁言 |
除此之外,还可以自定义群角色,但该角色拥有的客户端权限与普通成员一致。
设置成功后,群内成员通过以下 ZIM 回调收到通知:
iOS | Android | macOS | Windows | Web |
---|---|---|---|---|
groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated |
小程序 | Flutter | Unity3D | uni-app | React Native |
groupMemberInfoUpdated | onGroupMemberInfoUpdated | OnGroupMemberInfoUpdated | groupMemberInfoUpdated | groupMemberInfoUpdated |
接口原型
- 请求方法:GET
- 请求地址:
https://zim-api.zego.im/?Action=SetGroupMemberRole
- 传输协议:HTTPS
- 调用频率限制:20 次/秒
请求参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
FromUserId | String | 是 | 操作用户的 ID,建议填群主的用户 ID。 |
GroupId | String | 是 | 群组 ID。 |
ToUserId | String | 是 | 待设置角色的目标用户 ID。 |
Role | Number | 是 | 角色:
|
请求示例
Untitled
https://zim-api.zego.im/?Action=SetGroupMemberRole
&<公共请求参数>
&FromUserId=zego
&GroupId=group
&ToUserId=zego2
&Role=3
1
响应参数
参数 | 类型 | 描述 |
---|---|---|
Code | Number | 返回码。 |
Message | String | 请求结果的说明信息。 |
RequestId | String | 请求 ID。 |
响应示例
Untitled
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782"
}
1
返回码
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
660000001 | 服务端错误。 | 请重试,或联系 ZEGO 技术支持。 |
660000002 | 参数错误。 | 请检查输入的参数。 |
660300005 | 调用接口的频率超出了 AppID 级别限制。 | 请稍后重试 |
660600001 | 群不存在 | 请确认输入的 GroupId 是否正确。 |
660600009 | 查询群信息失败。 | 请先确认 GroupID 是否正确。如果正确,请联系 ZEGO 技术支持。 |
660600024 | ToUserId 不在群内。 | 请确认 ToUserId 是否在群内:
|
660600029 | Role 不能设置为 1。 | 请修改 Role。 |
660600030 | FromUserId 不能和 ToUserId相等。 | 请修改 ToUserId。 |