Sonos Developer

Your cloud queue has two strings, contextVersion and queueVersion, to signal changes in the cloud data. Each time the list of tracks, metadata, or skip enforcement data changes, you must change one of these version identifiers. The Sonos player is responsible for periodically polling this value to detect changes in the cloud queue track list, context metadata, or skip limits.

Request

The request contains the access token in the authorization header and the parameters in the table below (this has been deprecated in v2.0).

Parameter	Type	Description
`updateToken`	boolean	(Optional, v1.0 only) A boolean value indicating whether your cloud queue server should update the access token or not. This allows the player to disable access token refreshing when the user is not actively using the cloud queue.

Example

https://www.example.com/musicqueue/v2.0/version?updateToken=true

Response

Parameter Type Description

Parameter	Type	Description
`contextVersion`	string	Added in v2.0. Indicates the change state of the cloud queue context such as metadata and playback policies. When the context changes for your cloud queue server, you should also change this string. The player remembers this string so that it can detect changes when calling the cloud queue later. The player will call `GET /context` and apply the playback policies only after processing a `loadCloudQueue` command. Playback policies included in subsequent responses are ignored by the player until the next call to the `loadCloudQueue` command.
`queueVersion`	string	Indicates the change state of the contents in the cloud queue, such as the order of tracks. When the contents change for your cloud queue server, you should also change this string. The player remembers this string so that it can detect changes when calling the cloud queue later.

contextVersion

string

Added in v2.0. Indicates the change state of the cloud queue context such as metadata and playback policies. When the context changes for your cloud queue server, you should also change this string. The player remembers this string so that it can detect changes when calling the cloud queue later.

The player will call GET /context and apply the playback policies only after processing a loadCloudQueue command. Playback policies included in subsequent responses are ignored by the player until the next call to the loadCloudQueue command.

queueVersion string Indicates the change state of the contents in the cloud queue, such as the order of tracks. When the contents change for your cloud queue server, you should also change this string. The player remembers this string so that it can detect changes when calling the cloud queue later.

If the access token is set to expire soon, you should include an updated token in the X-Updated-Authorization header. See Play audio for details.

Example

{
  "contextVersion": "context_version_1",
  "queueVersion": "queue_version_1"
}

{

"contextVersion": "context_version_1",

"queueVersion": "queue_version_1"

}