Sonos Developer

Use this command to poll for metadata changes. This command returns a metadataStatus object for the target group.

Endpoint

GET

groups/{groupId}/playbackMetadata

1	groups/{groupId}/playbackMetadata

Request Parameters

There are no request parameters in the body, all of the request parameters are in the header.

This command requires a groupId to determine the target of the command. See the Control documentation for details.

Response

Returns a metadataStatus object for the target group.

In the event of a failure, returns a globalError.

Examples

Request

GET https://api.ws.sonos.com/control/api/v1/groups/{{groupId}}/playbackMetadata

1	GET https://api.ws.sonos.com/control/api/v1/groups/{{groupId}}/playbackMetadata

Response

{
    "container": {
        "name": "Sample playlist",
        "type": "playlist",
        "id": {
            "serviceId": "255",
            "objectId": "playlist:ABC",
            "accountId": "Z123"
        },
        "service": {
            "name": "ACME Music",
            "id": "204"
        },
        "imageUrl": "http://acme.example.com/image/thumb/ABC/400x400image.jpeg"
    },
    "currentItem": {
        "track": {
            "type": "track",
            "name": "Sample track",
            "imageUrl": "http://0.0.0.0:1400/getaa?ABC123",
            "album": {
                "name": "Sample album"
            },
            "artist": {
                "name": "Sample artist"
            },
            "id": {
                "serviceId": "255",
                "objectId": "track:DEF",
                "accountId": "Z123"
            },
            "service": {
                "name": "ACME Music",
                "id": "255"
            },
            "durationMillis": 570000
        }
    }
}

{

"container": {

"name": "Sample playlist",

"type": "playlist",

"id": {

"serviceId": "255",

"objectId": "playlist:ABC",

"accountId": "Z123"

"service": {

"name": "ACME Music",

"id": "204"

"imageUrl": "http://acme.example.com/image/thumb/ABC/400x400image.jpeg"

"currentItem": {

"track": {

"type": "track",

"name": "Sample track",

"imageUrl": "http://0.0.0.0:1400/getaa?ABC123",

"album": {

"name": "Sample album"

"artist": {

"name": "Sample artist"

"id": {

"serviceId": "255",

"objectId": "track:DEF",

"accountId": "Z123"

"service": {

"name": "ACME Music",

"id": "255"

"durationMillis": 570000

}