SetWhiteboardRoomAuth
https://whiteboard-api.zego.im/
Call this API to set the default whiteboard permissions for a room.
- After successful configuration, users in this room will use the whiteboard with these room permissions by default.
- If user permissions are set separately, those users will use the whiteboard according to their user-level permissions.
- When a room is destroyed, its permissions are also cleared. After destruction, if users log into a room with the same RoomId and want to use room permissions, they need to set the room permissions again.
Set the room default permissions to:
- Whiteboard can be zoomed and scrolled.
- Can create graphic elements and modify others' graphic elements.
NoteRate limit: 50 requests/second (Test environment: 1 request/second).
Request
Query Parameters
- 0: No permission
- 1: Allow zooming the whiteboard
- 2: Allow scrolling the whiteboard
- 0: No operation permission
- 2: Allow modifying graphic elements created by others
- 4: Allow erasing graphic elements created by others
- 8: Allow moving graphic elements created by others
- 16: Allow clearing graphic elements
- 32: Allow creating graphic elements
Possible values: [SetWhiteboardRoomAuth]
API endpoint parameter
https://whiteboard-api.zego.im/?Action=SetWhiteboardRoomAuth
ð¡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
ð¡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature sample code for how to generate.
ð¡Public parameter. Current Unix timestamp, in seconds. Refer to Signature sample code for how to generate, with a maximum error of 10 minutes.
Possible values: [2.0]
Default value: 2.0
ð¡Public parameter. Signature version number.
ð¡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate.
The room ID to set permissions for.
Possible values: [0, 1, 2]
Whiteboard operation permission set. Empty arrays are not allowed.
Example: ModuleAuth[]=1&ModuleAuth[]=2
Possible values: [0, 2, 4, 8, 16, 32]
Graphic element operation permission set. Empty arrays are not allowed.
Example: GraphicAuth[]=32&GraphicAuth[]=2
Responsesâ
- 200
- application/json