Set Whiteboard Permissions of the Room

1 Description

Call this interface to set the default whiteboard permission of the room.

• After the setting is successful, when the user in the current room uses the whiteboard, the default permission of the room set this time shall prevail.
• If user permission is set alone, this user uses the whiteboard according to the user authority.
• When the room is destroyed, the room permissions will also be cleared. After the room is destroyed, the user subsequently logs in to the room with the same RoomId. If you want to use the room permission function, you also need to reset the room permission.

Call frequency limit:

• Formal environment: 50 times/sec
• Test environment: 1 time/sec

2 Request Method and Endpoint

• Request method: GET
• Request endpoint: https://whiteboard-api.zego.im/?Action=SetWhiteboardRoomAuth
• Transmission protocol: HTTPS

3 Request Parameters

The following request parameter list only lists the interface request parameters. For the list of public parameters, please refer to API Call Method - Public Request Parameters.

4 Request Example

The following is an example of a request for the room permission interface. Only the interface request parameters are listed in the request example. For public request parameters, please refer to the request example in API Call Method - Public Request Parameters.

Set the default permissions of the room as:

1. The whiteboard can be zoomed and scrolled.
2. You can create graphic elements and modify other people’s graphic elements.

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

5 Response Parameters

6 Response Example

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

7 Return Code