SOsonos
playback

seek

Use the seek command in the playback namespace to go to a specific 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 an ERROR_INVALID_OBJECT_ID error.

post/groups/{groupId}/playback/seek

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/groups/{groupId}/playback/seek
  • Auth
    OAuth 2 and HTTP bearer and API key in header X-Sonos-Api-Key
    Authorization code: https://api.sonos.com/login/v3/oauth
    Token URL: https://api.sonos.com/login/v3/oauth/access scopes: playback-control-all

Request body

itemIdstring nullable

(Optional) The identifier for the item. If included and it 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 or due to latency.

positionMillisinteger required

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.

Response

Success Code: 200 OK

Content Examples:

  1. When including the optional itemId.
{
"positionMillis" : 30000,
"itemId" : "123"
}
  1. When omitting the optional itemId.
{
"positionMillis" : 30000
}
Ok required

This object represents an empty (default) success. The platform returns an empty object ({}).

Changes

No recorded changes to this operation across all 1 revision of this API.