Set room permissions

Description

Sets the default room permissions on a whiteboard.

• After the setting, when a user uses a whiteboard in the room, the room is granted with the default permissions on the whiteboard.
• If user permissions on a whiteboard have been set by referring to Set user permissions, the user permissions prevail.
• When a room is destructed, room permissions are cleared. After a room is destructed, room permissions need to be set again when users log in to the room with the same room ID.

Request method and endpoint

• Request method: GET
• Request endpoint: https://whiteboard-api.zego.im/?Action=SetWhiteboardRoomAuth
• Protocol: HTTPS
• Rate limit: 50 requests/second (test environment: 1 request/second)

Request parameters

Listed below are the parameters specific to this request. For the complete list of public request parameters, see Accessing Server APIs - Public parameters..

Sample request

Set the following default room permissions:

1. Zoom in or out on, scroll, and turn pages on the whiteboard.
2. Create diagram elements and modify diagram elements created by others.

https://whiteboard-api.zego.im/?Action=SetWhiteboardRoomAuth
&RoomId=RoomName
&ModuleAuth[]=1&ModuleAuth[]=2
&GraphicAuth[]=32&GraphicAuth[]=2
&<Public request parameters>

Response parameters

Sample response

{
    "Code":0,
    "Message":"SUCCESS",
    "RequestId":"2237080460466033406"
}

Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.