playbackMetadata

getMetadataStatus

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

get/groups/{groupId}/playbackMetadata

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/groups/{groupId}/playbackMetadata
  • 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

Response

See the x-muse-error-codes extension for a list of muse errors that generate this response

streamInfostring nullable

(Optional) An unstructured text string describing what is currently playing. Typically only available for stations that do not have currentItem information.

Changes

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