API Reference
Dev Portal

seekRelative

post
{protocol}://api.ws.sonos.com/control/api/{version}/groups//playback/seekRelative

Use the seekRelative command in the playback namespace to seek to the a relative position in the current track. Optionally add the cloud queue itemId to target a specific track.

Use itemId to ensure the group seeks on the current item. If the current item’s itemId does not match the one provided, the player returns ERROR_INVALID_OBJECT_ID.

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

Target groupId

Body Params
string | null

(Optional) The identifier for the item. If this parameter does not match the currently playing item, the command fails. This ensures that playback does not jump back to a track if a user starts to scrub just as the player begins to play the next item.

int32
required

Relative position within track in milliseconds. If this value exceeds the current track duration time, Sonos moves to the end of the current track, which results in a skip to the next track.

Headers
uuid
deprecated

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

uuid

Correlation UUID for data tracking purposes

Responses

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

500

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

503

Player is unable to reach the service.

Updated 23 days ago

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

Updated 23 days ago