Documentation
Cloud Recording
API Documents
Update the Whiteboard

Update the whiteboard

Last updated：2024-10-17 15:02

Description

Updates the whiteboard at any time during the recording.

We recommend that you call the UpdateWhiteboard method to update the whiteboard ID upon whiteboard switchover during the recording.

Request method and endpoint

Request method: POST
Request endpoint: https://cloudrecord-api.zego.im/?Action=UpdateWhiteboard
Transmission protocol: HTTPS
Rate limit: 10 requests/second

Request parameters

Listed below are the parameters specific to this request. For the list of public request parameters, see Accessing Server APIs - Public parameters.

Parameter	Type	Required	Description
TaskId	Int	Yes	Task ID. The value is a 16-byte character string.
WhiteboardId	String	Yes	Whiteboard ID.

Sample request

The following is a request example of the UpdateWhiteboard method:

Request URL

https://cloudrecord-api.zego.im/?Action=UpdateWhiteboard
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0

Request message body

{
  "TaskId": "xxxx",
  "WhiteboardId": "1111"
}

Response parameters

Parameter	Type	Description
Code	Int64	Return code.
Message	String	Description of the request execution result.
RequestId	String	Request ID.

Sample response

The following is a response example of the UpdateWhiteboard method:

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