# getReplaceBackground

Version: 4.2.0+

Description: retrieve the status of the background replacement feature.

Request example:

{
    "method" : "getReplaceBackground",
    "requestId" : "1"
}

Response example:

{
    "method": "getReplaceBackground",
    "requestId" : "1",
    "enabled" : true,
    "fileId" : 346234218,
    "result": true
}

Parameter description:

requestId - a unique request identifier. You can learn more about it here.
enabled - status of the background replacement feature
fileId - an optional return parameter that signifies the file identifier on the built-in HTTP server, which is used to replace the background. If the parameter is missing, the default background is used.

See also: