UpdateWhiteboard

POST

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

During the recording process, you can call this API at any time to change the whiteboard being recorded.

When users switch whiteboards, it is recommended that developers call the UpdateWhiteboard API to update the whiteboard ID after switching.

Note

Call frequency limit: 10 times/second

Request

Query Parameters

Action stringrequired

Possible values: [UpdateWhiteboard]

API prototype parameter

https://cloudrecord-api.zego.im?Action=UpdateWhiteboard

AppId uint32required

💡Common parameter. Application ID, a unique credential assigned by ZEGOCLOUD. You can obtain it from the ZEGOCLOUD Console.

SignatureNonce stringrequired

💡Common parameter. A 16-character hexadecimal random string (hex encoding of an 8-byte random number). For the generation algorithm, refer to Signature Example.

Timestamp int64required

💡Common parameter. Current Unix timestamp in seconds. For the generation algorithm, refer to Signature Example. A maximum error of 10 minutes is allowed.

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡Common parameter. Signature version number.

Signature stringrequired

💡Common parameter. Signature used to verify the legitimacy of the request. Please refer to Signature Mechanism for generation.

application/json

Body

required

TaskId stringrequired

Recording task ID, a fixed-length string of 16 bytes.

WhiteboardId stringrequired

ID of the whiteboard to be recorded.

Responses

application/json

Schema
Example (from schema)

Schema

Code int64

Error code.

Message string

Error description.

RequestId string

Request ID.

{
  "Code": 0,
  "Message": "succeed",
  "RequestId": "abcd123"
}

{
  "Code": 0,
  "Message": "succeed",
  "RequestId": "abcd123"
}