logo
当前页

设置群成员角色


描述

调用此接口,可以为群成员设置在群内的角色。

ZIM SDK 默认支持将用户设置为群主、管理员、普通成员。在群组中,群主拥有所有客户端权限,可以实现所有群组功能。管理员拥有大部分客户端权限。普通成员拥有的客户端权限最少,具体如下表所示:

客户端权限群主(对应枚举值为 1)管理员(对应枚举值为 2)普通成员(对应枚举值为 3)
修改群头像、群名称、群公告支持支持支持
修改群属性
修改群成员昵称支持,可对所有群角色用户使用此功能支持,可对所有普通成员使用此功能支持,仅可对自己使用此功能
撤回群成员消息
踢人不支持。
对单独群成员禁言
对特定群角色禁言
设置群成员角色不支持
转让群主
解散群组
全员禁言

除此之外,还可以自定义群角色,但该角色拥有的客户端权限与普通成员一致。

设置成功后,群内成员通过以下 ZIM 回调收到通知:

iOSAndroidmacOSWindowsWeb
groupMemberInfoUpdatedonGroupMemberInfoUpdatedgroupMemberInfoUpdatedonGroupMemberInfoUpdatedgroupMemberInfoUpdated
小程序FlutterUnity3Duni-appReact Native
groupMemberInfoUpdatedonGroupMemberInfoUpdatedOnGroupMemberInfoUpdatedgroupMemberInfoUpdatedgroupMemberInfoUpdated

接口原型

  • 请求方法:GET
  • 请求地址:https://zim-api.zego.im/?Action=SetGroupMemberRole
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数类型是否必选描述
FromUserIdString操作用户的 ID,建议填群主的用户 ID。
GroupIdString群组 ID。
ToUserIdString待设置角色的目标用户  ID。
RoleNumber角色:
  • 2: 管理员。
  • 3: 普通成员。
  • 其他值:可自定义角色,取值范围建议为 [100, 255],权限与普通成员一致。

请求示例

Untitled
https://zim-api.zego.im/?Action=SetGroupMemberRole
&<公共请求参数>
&FromUserId=zego
&GroupId=group
&ToUserId=zego2
&Role=3
1
Copied!

响应参数

参数类型描述
CodeNumber返回码。
MessageString请求结果的说明信息。
RequestIdString请求 ID。

响应示例

Untitled
{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}
1
Copied!

返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码说明处理建议
660000001服务端错误。请重试,或联系 ZEGO 技术支持。
660000002参数错误。请检查输入的参数。
660300005调用接口的频率超出了 AppID 级别限制。请稍后重试
660600001群不存在请确认输入的 GroupId 是否正确。
660600009查询群信息失败。请先确认 GroupID 是否正确。如果正确,请联系 ZEGO 技术支持。
660600024ToUserId 不在群内。请确认 ToUserId 是否在群内:
  • 如果在,请联系 ZEGO 技术支持处理。
  • 如果不在,请将ToUserId 拉进群。
660600029Role 不能设置为 1。请修改 Role。
660600030FromUserId 不能和 ToUserId相等。请修改 ToUserId。

Previous

设置群成员昵称

Next

设置群禁言