MusicServices service

Access to external music services, like Spotify or Youtube Music

The MusicServices service is available on these models: Sonos Play:1 (S1) S2 / Sonos One (S13) S2 / Sonos Beam (S14) S2 / Sonos One (S18) S2 / SYMFONISK Bookshelf (S21) S2 / Sonos Roam (S27) S2 / Sonos Play:3 (S3) S2 / SYMFONISK Bookshelf (S33) S2 / Sonos One SL (S38) S2 / Sonos Play:5 (S6) S2 / Sonos Playbar (S9) S2 / Sonos Sub (Sub) S2.

1. Available actions
   1. GetSessionId
   2. ListAvailableServices
   3. UpdateAvailableServices
2. Events
   1. Subscribe to events
   2. Event variables

Service data

Sample request

POST /MusicServices/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-upnp-org:service:MusicServices:1#{ActionName}"
Content-Type: text/xml; charset="utf-8"

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <s:Body>
    {ActionBodyHere}
  </s:Body>
</s:Envelope>

Available actions

GetSessionId

Action body:

<u:GetSessionId xmlns:u="urn:schemas-upnp-org:service:MusicServices:1">
  <ServiceId>ui4</ServiceId>
  <Username>string</Username>
</u:GetSessionId>

Inputs:

Outputs:

ListAvailableServices

Load music service list as xml

Action body:

<u:ListAvailableServices xmlns:u="urn:schemas-upnp-org:service:MusicServices:1">
</u:ListAvailableServices>

No input arguments

Outputs:

Remarks Some libraries also support ListAndParseAvailableServices

UpdateAvailableServices

Action body:

<u:UpdateAvailableServices xmlns:u="urn:schemas-upnp-org:service:MusicServices:1">
</u:UpdateAvailableServices>

No input arguments

Events

The MusicServicesService has variables that might be emitted if you subscribe to events.

Subscribe to events

SUBSCRIBE /MusicServices/Event
Host: 192.168.x.x:1400
callback: <http://...>
NT: upnp:event
Timeout: Second-3600

Event variables

If the variable has a ✔ in the Sends events column, the service discovery specifies this variable emits events. Other properties might be send as a part of LastChange

This file is automatically generated with @svrooij/sonos-docs, do not edit manually.