文档中心
ZegoSuperBoard 超级白板
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 超级白板
  • 服务端 API
  • 设置用户权限

服务端 API 版块于4月16日至5月15日升级维护,期间暂停信息更新,如有任何疑问,请联系ZEGO技术支持。

设置用户权限

更新时间:2025-04-15 19:16

1 描述

调用本接口设置用户的白板权限。

  • 用户退出房间或掉线,该用户权限会被清理。该用户下一次再登录相同的房间,如果要使用用户权限功能,需要重新设置一次用户权限。
  • 用户所在的房间被销毁,该用户权限也会被清理掉。

2 接口原型

  • 请求方法:GET
  • 请求地址:https://whiteboard-api.zego.im/?Action=SetWhiteboardUserAuth
  • 传输协议:HTTPS
  • 调用频率限制:50 次/秒(测试环境:1 次/秒)

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 中的 “2.1 公共请求参数”。

参数 类型 是否必选 描述
RoomId
String
是
需要设置的房间 ID。
UserId
String
是
需要设置的用户 ID。
ModuleAuth[]
Array of Number
是
白板操作权限集合,不允许传空数组。
  • 0:没有权限
  • 1:允许缩放白板
  • 2:允许滚动白板
示例:ModuleAuth[]=1&ModuleAuth[]=2
GraphicAuth[]
Array of Number
是
图元操作权限集合,不允许传空数组。
  • 0:没有任何操作权限
  • 2:允许修改其他人创建的图元
  • 4:允许擦除其他人创建的图元
  • 8:允许移动其他人创建的图元
  • 16:允许清空图元
  • 32:允许创建图元
示例:GraphicAuth[]=32&GraphicAuth[]=2

4 请求示例

设置用户权限为:

  1. 白板可缩放,可滚动翻页。
  2. 可以创建图元,可以修改别人的图元。
https://whiteboard-api.zego.im/?Action=SetWhiteboardUserAuth
&RoomId=RoomName
&UserId=jack
&ModuleAuth[]=1&ModuleAuth[]=2
&GraphicAuth[]=32&GraphicAuth[]=2
&<公共请求参数>

5 响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
明细。
RequestId
String
ZEGO 生成的唯一请求 ID。

6 响应示例

{
    "Code":0,
    "Message":"SUCCESS",
    "RequestId":"2237080460466033406"
}

7 返回码

以下仅列出了接口业务相关的返回码,公共返回码请参考 公共返回码。

返回码 说明
120000001
签名鉴权失败。
120000002
输入参数错误。
120000101
设置用户权限失败。
120000105
权限集合传了空数组导致失败。
120000106
权限集合设置了不合法的权限数字。
120000201
用户不存在。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈