SetWhiteboardUserAuth

GET

https://whiteboard-api.zego.im/

Call this API to set a user's whiteboard permissions.

When a user leaves the room or disconnects, the user's permissions are cleared. If the user logs into the same room again and wants to use user permissions, they need to set the user permissions again.
When the room that the user is in is destroyed, the user's permissions are also cleared.

Set the user permissions to:

Whiteboard can be zoomed and scrolled.
Can create graphic elements and modify others' graphic elements.

Note

Rate limit: 50 requests/second (Test environment: 1 request/second).

Request

Query Parameters

Action stringrequired

Possible values: [SetWhiteboardUserAuth]

API endpoint parameter

https://whiteboard-api.zego.im/?Action=SetWhiteboardUserAuth

AppId uint32required

💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

SignatureNonce stringrequired

💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature sample code for how to generate.

Timestamp int64required

💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature sample code for how to generate, with a maximum error of 10 minutes.

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡Public parameter. Signature version number.

Signature stringrequired

💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate.

RoomId stringrequired

The room ID to set permissions for.

UserId stringrequired

The user ID to set permissions for.

ModuleAuth number[]required

Possible values: [0, 1, 2]

Whiteboard operation permission set. Empty arrays are not allowed.

0: No permission
1: Allow zooming the whiteboard
2: Allow scrolling the whiteboard

Example: ModuleAuth[]=1&ModuleAuth[]=2

GraphicAuth number[]required

Possible values: [0, 2, 4, 8, 16, 32]

Graphic element operation permission set. Empty arrays are not allowed.

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

Example: GraphicAuth[]=32&GraphicAuth[]=2

Responses

application/json

Schema
Example (from schema)

Schema

Code number

Return code.

Only business-related return codes are listed below. For common return codes, please refer to Common error codes.

Return code	Description
120000001	Signature authentication failed.
120000002	Invalid input parameters.
120000101	Failed to set user permissions.
120000105	Failed because an empty array was passed for the permission set.
120000106	Invalid permission value set in the permission collection.
120000201	User does not exist.

Message string

Details.

RequestId string

Unique request ID generated by ZEGOCLOUD.

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

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

SetWhiteboardUserAuth

https://whiteboard-api.zego.im/

Request

Query Parameters

Responses​

Responses