GetWhiteboardRoomAuth

GET

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

调用本接口查询房间的默认白板权限。

说明

调用频率限制：50 次/秒（测试环境：1 次/秒）。

Request

Query Parameters

Action string必填

可选值: [GetWhiteboardRoomAuth]

接口原型参数

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

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。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code number

返回码。

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

返回码	说明
120000001	签名鉴权失败。
120000002	输入参数错误。
120000104	查询房间权限失败。
120000301	房间不存在。

Message string

明细。

RequestId string

ZEGO 生成的唯一请求 ID。

Data object

如果 Data 为空, 说明该房间没有设置过白板权限。

RoomId string

房间 ID 号。

ModuleAuth integer[]

可选值: [0, 1, 2]

白板操作权限集合。

0：没有权限
1：允许缩放白板
2：允许滚动白板

GraphicAuth integer[]

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

图元操作权限集合。

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

{
  "Code": 0,
  "Message": "SUCCESS",
  "RequestId": "223708046046603340",
  "Data": {
    "RoomId": "RoomName",
    "ModuleAuth": [
      1,
      2
    ],
    "GraphicAuth": [
      32,
      2
    ]
  }
}

{
  "Code": 0,
  "Message": "SUCCESS",
  "RequestId": "223708046046603340",
  "Data": {
    "RoomId": "RoomName",
    "ModuleAuth": [
      1,
      2
    ],
    "GraphicAuth": [
      32,
      2
    ]
  }
}

GetWhiteboardRoomAuth

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

Request

Query Parameters

Responses​

Responses