Documentation
Super Board (Full version)
Server API V2
Query room permissions

Query room permissions

Last updated：2022-12-21 17:44

Description

Queries the default room permissions on a whiteboard.

Request method and endpoint

Request method: GET
Request endpoint: https://whiteboard-api.zego.im/?Action=GetWhiteboardRoomAuth
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..

Parameter	Type	Required	Description
RoomId	String	Yes	Room ID.

Sample request

https://whiteboard-api.zego.im/?Action=GetWhiteboardRoomAuth
&RoomId=RoomName
&<Public request parameters>

Response parameters

Parameter	Type	Description
Code	Number	Return code.
Message	String	Message.
RequestId	String	Unique request ID generated by ZEGO.
Data	Object	If the value is empty, no permission on whiteboards has been set for the room.
└ RoomId	String	Room ID.
└ ModuleAuth[]	Array of Number	Operation permissions on whiteboards. 0: no permission 1: zooming 2: scrolling
└ GraphicAuth[]	Array of Number	Operation permissions on diagram elements. 0: no permission 2: modifying diagram elements created by other users 4: erasing diagram elements created by other users 8: moving diagram elements created by other users 16: deleting all diagram elements 32: creating diagram elements

Sample response

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

Return codes

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

Return code	Description
120000001	Signature authentication failed.
120000002	Incorrect input parameters.
120000104	Failed to query room permissions.
120000301	The room does not exist.