设置群成员角色
GET
https://zim-api.zego.im/
调用此接口，可以为群成员设置在群内的角色。
ZIM SDK 默认支持将用户设置为群主、管理员、普通成员。在群组中，群主拥有所有客户端权限，可以实现所有群组功能。管理员拥有大部分客户端权限。普通成员拥有的客户端权限最少，具体如下表所示：
| 客户端权限 | 群主（对应枚举值为 1） | 管理员（对应枚举值为 2） | 普通成员（对应枚举值为 3） |
|---|---|---|---|
| 修改群头像、群名称、群公告 | 支持 | 支持 | 支持 |
| 修改群属性 | |||
| 修改群成员昵称 | 支持，可对所有群角色用户使用此功能 | 支持，可对所有普通成员使用此功能 | 支持，仅可对自己使用此功能 |
| 撤回群成员消息 | |||
| 踢人 | 不支持。 | ||
| 对单独群成员禁言 | |||
| 对特定群角色禁言 | |||
| 设置群成员角色 | 不支持 | ||
| 转让群主 | |||
| 解散群组 | |||
| 全员禁言 |
除此之外，还可以自定义群角色，但该角色拥有的客户端权限与普通成员一致。
设置成功后，群内成员通过以下 ZIM 回调收到通知：
| iOS | Android | macOS |
|---|---|---|
| groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated |
| Windows | Web | 小程序 |
|---|---|---|
| onGroupMemberInfoUpdated | groupMemberInfoUpdated | groupMemberInfoUpdated |
| Flutter | Unity3D | uni-app |
|---|---|---|
| onGroupMemberInfoUpdated | OnGroupMemberInfoUpdated | groupMemberInfoUpdated |
| React Native | HarmonyOS | |
|---|---|---|
| groupMemberInfoUpdated | groupMemberInfoUpdated |
说明
说明
调用频率限制：20 次/秒。
Request
Query Parameters
- 2: 管理员。
- 3: 普通成员。
- 其他值：可自定义角色，取值范围建议为 [100, 255]，权限与普通成员一致。
Action string必填
可选值: [SetGroupMemberRole]
接口原型参数
https://zim-api.zego.im/?Action=SetGroupMemberRole
AppId uint32必填
💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
FromUserId string必填
可选值: <= 32 characters
操作用户 ID，建议填群主 ID。
注意
此参数不能与 ToUserId 相同。
GroupId string必填
可选值: <= 32 characters
群组 ID。
ToUserId string必填
可选值: <= 32 characters
待设置角色的目标用户 ID。
Role number必填
可选值: [2, 3]
角色：
Responses
- 200
OK
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
ZEGO 签名生成器
RESPONSE清除
点击上方 “发送” 按钮，在此处查看响应。