SetWhiteboardRoomAuth
GET
https://whiteboard-api.zego.im/
调用本接口用来设置房间的默认白板权限。
- 设置成功后,在当前房间的用户使用白板时,默认以这次设置的房间权限为准。
- 如果单独 设置了用户的权限,这个用户使用白板以用户权限为准。
- 房间销毁时,房间权限也会被清理。房间销毁后,用户后续登录相同 RoomId 的房间,如果要使用房间权限功能,也需要重新设置房间权限。
设置房间默认权限为:
- 白板可缩放,可滚动翻页。
- 可以创建图元,可以修改别人的图元。
说明调用频率限制:50 次/秒(测试环境:1 次/秒)。
Request
Query Parameters
- 0:没有权限
- 1:允许缩放白板
- 2:允许滚动白板
- 0:没有任何操作权限
- 2:允许修改其他人创建的图元
- 4:允许擦除其他人创建的图元
- 8:允许移动其他人创建的图元
- 16:允许清空图元
- 32:允许创建图元
Action string必填
可选值: [SetWhiteboardRoomAuth]
接口原型参数
https://whiteboard-api.zego.im/?Action=SetWhiteboardRoomAuth
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。
ModuleAuth number[]必填
可选值: [0, 1, 2]
白板操作权限集合,不允许传空数组。
示例:ModuleAuth[]=1&ModuleAuth[]=2
GraphicAuth number[]必填
可选值: [0, 2, 4, 8, 16, 32]
图元操作权限集合,不允许传空数组。
示例:GraphicAuth[]=32&GraphicAuth[]=2
Responses
- 200
OK
- application/json
