logo
当前页

GetWhiteboardUserAuth

GET

https://whiteboard-api.zego.im/

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

说明
调用频率限制:50 次/秒(测试环境:1 次/秒)。

Request

Query Parameters

    Action string必填

    可选值: [GetWhiteboardUserAuth]

    接口原型参数

    https://whiteboard-api.zego.im/?Action=GetWhiteboardUserAuth

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

    RoomId string必填

    需要查询的房间 ID。

    UserId string[]必填

    可选值: <= 10

    需要查询的用户 ID 集合, 一次最多允许查询 10 个用户。

Responses

OK
Schema
    Code number

    返回码。

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

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

    明细。

    RequestId string

    ZEGO 生成的唯一请求 ID。

    Data object[]
    如果 Data 为空, 说明该房间没有设置过白板权限。
  • Array[
  • UserId string

    用户 ID。

    ModuleAuth integer[]

    可选值: [0, 1, 2]

    白板操作权限集合。

    • 0:没有权限
    • 1:允许缩放白板
    • 2:允许滚动白板
    GraphicAuth integer[]

    可选值: [0, 2, 4, 8, 16, 32]

    图元操作权限集合。

    • 0:没有任何操作权限
    • 2:允许修改其他人创建的图元
    • 4:允许擦除其他人创建的图元
    • 8:允许移动其他人创建的图元
    • 16:允许清空图元
    • 32:允许创建图元
  • ]

上一篇

查询房间权限

下一篇

公共返回码

当前页

返回到顶部