Updates the screen recording settings for remote control sessions

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Saves the screen recording configuration for remote control sessions, including enable/disable toggle, frame rate, codec, color quality, storage limits, and whether authenticated download is required. Accepts a JSON body with the screen recording settings model.

Request URL

https://{serverurl}/dcapi/tools/remoteControl/screenRecording

Scope

DesktopCentralCloud.RemoteControl.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/scrRecSettingsStatus.v1+jsonapplication/scrRecSettingsStatus.v1+jsonCopied!
Content-TypestringMandatory
application/scrRecSettingsInfo.v1+jsonapplication/scrRecSettingsInfo.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
recErrActionstringOptional
isNotifyUserEnabledstringOptional
notifyMessagestringMandatory
isScreenRecEnabledstringOptional
isAuthVideoDownloadstringOptional
framesPerSecstringOptional
recMaintainsSizeintegerOptional
codecTypestringOptional
driveFreeSpacestringOptional
colorQualitystringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/dcapi/tools/remoteControl/screenRecording \
  --header 'Accept: application/scrRecSettingsStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/scrRecSettingsInfo.v1+json' \
  --data '{"notifyMessage":"This session is being recorded."}'

Sample Request Body

Copied!
  {
    "recErrAction": 1,
    "isNotifyUserEnabled": 1,
    "notifyMessage": "This session is being recorded.",
    "isScreenRecEnabled": 1,
    "framesPerSec": 15,
    "recMaintainsSize": 500,
    "codecType": 1,
    "driveFreeSpace": 1,
    "colorQuality": 2,
    "isAuthVideoDownload": 0
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusstring

Result of the operation: success or failure

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "status": "success"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.