Update the whiteboard

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.

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
  &IsTest=false

• Request message body

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

Response parameters

Sample response

The following is a response example of the UpdateWhiteboard method:

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