文档中心
超级白板
服务端 API
查询用户权限

查询用户权限

更新时间：2024-05-01 18:15

1 描述

调用本接口用来查询用户的白板权限，每次最多允许查询 10 个用户的权限。如果查询的用户中没有设置过权限，服务端不会返回该用户的权限数据。

2 接口原型

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

3 请求参数

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

参数	类型	是否必选	描述
RoomId	String	是	需要查询的房间 ID。
UserId[]	Array of String	是	需要查询的用户 ID 集合, 一次最多允许查询 10 个用户。

4 请求示例

https://whiteboard-api.zego.im/?Action=GetWhiteboardUserAuth
&RoomId=RoomName
&UserId[]=jack&UserId[]=tom
&<公共请求参数>

5 响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	明细。
RequestId	String	ZEGO 生成的唯一请求 ID。
Data	Object	如果 Data 为空, 说明该房间没有设置过白板权限。
└ UserId	String	用户 ID。
└ ModuleAuth[]	Array of Number	白板操作权限集合。 0：没有权限 1：允许缩放白板 2：允许滚动白板
└ GraphicAuth[]	Array of Number	图元操作权限集合。 0：没有任何操作权限 2：允许修改其他人创建的图元 4：允许擦除其他人创建的图元 8：允许移动其他人创建的图元 16：允许清空图元 32：允许创建图元

6 响应示例

{
    "Code":0,
    "Message":"SUCCESS",
    "RequestId":"2237080460466033406",
    "Data":[
        {
            "UserId":"jack",
            "ModuleAuth":[1,2],
            "GraphicAuth":[32,2]
        },
        {
            "UserId":"tom",
            "ModuleAuth":[1,2],
            "GraphicAuth":[32]
        }
    ]
}

7 返回码

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

返回码	说明
120000001	签名鉴权失败。
120000002	输入参数错误。
120000102	查询用户权限失败。
120000107	获取用户数量超过限制。
120000301	房间不存在。