duck

Ducking temporarily lowers the zone's volume without affecting the observed system volume. Sending another "duck" command to a system that is already ducking does not affect the output level. However, it does reset the duration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Target playerId

Body Params
int32 | null
0 to 60000

Ducking lasts for the specified time, unless explicitly ended with the "unduck" command. The default value is 3 seconds when this value is omitted. The minimum value is 0 seconds. The maximum value is 60 seconds. Values outside the valid range are clamped.

Headers
uuid
deprecated

Client API Key for the integration. Required in V1 but deprecated in V2.

uuid

Correlation UUID for data tracking purposes

Responses

400

The given resource/object identifier is invalid

401

A client has not provided authorization credentials to perform a command

403

A client does not have the correct permissions to perform a command

404

A command was targeted to a group that no longer is the same group

499

Indicates there was an error occurred when performing a command

500

Sonos has experience an unexpected condition it is unable to recover from

503

Player is unable to reach the service.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json