GetWhiteboardUserAuth

GET

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

Call this API to query users' whiteboard permissions. A maximum of 10 users can be queried at a time. If no permissions have been set for a queried user, the server will not return that user's permission data.

Note

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

Request

Query Parameters

Action stringrequired

Possible values: [GetWhiteboardUserAuth]

API endpoint parameter

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

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 query.

UserId string[]required

Possible values: <= 10

The collection of user IDs to query. A maximum of 10 users can be queried at a time.

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.
120000102	Failed to query user permissions.
120000107	Number of users to query exceeds the limit.
120000301	Room does not exist.

Message string

Details.

RequestId string

Unique request ID generated by ZEGOCLOUD.

Data object[]

If Data is empty, it means no whiteboard permissions have been set for this room.

Array[

UserId string

User ID.

ModuleAuth integer[]

Possible values: [0, 1, 2]

Whiteboard operation permission set.

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

GraphicAuth integer[]

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

Graphic element operation permission set.

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

]

{
  "Code": 0,
  "Message": "SUCCESS",
  "RequestId": "2237080460466033406",
  "Data": [
    {
      "UserId": "jack",
      "ModuleAuth": [
        1,
        2
      ],
      "GraphicAuth": [
        32,
        2
      ]
    }
  ]
}

{
  "Code": 0,
  "Message": "SUCCESS",
  "RequestId": "2237080460466033406",
  "Data": [
    {
      "UserId": "jack",
      "ModuleAuth": [
        1,
        2
      ],
      "GraphicAuth": [
        32,
        2
      ]
    }
  ]
}

GetWhiteboardUserAuth

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

Request

Query Parameters

Responses​

Responses