Link Search Menu Expand Document

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

name value
Control URL http://192.168.x.x:1400/MusicServices/Control
Event subscription URL http://192.168.x.x:1400/MusicServices/Event
Discovery URL http://192.168.x.x:1400/xml/MusicServices1.xml
Service ID urn:upnp-org:serviceId:MusicServices
Service type urn:schemas-upnp-org:service:MusicServices:1

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="" s:encodingStyle="">

Available actions


Action body:

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


parameter type description
ServiceId ui4  
Username string  


parameter type description
SessionId string  


Load music service list as xml

Action body:

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

No input arguments


parameter type description
AvailableServiceDescriptorList string  
AvailableServiceTypeList string  
AvailableServiceListVersion string  

Remarks Some libraries also support ListAndParseAvailableServices


Action body:

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

No input arguments


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

Variable Sends events* type possible values
ServiceId   ui4  
ServiceListVersion string  
SessionId   string  
Username   string  

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.

Device Software generation Software version Discovery date
Sonos Play:1 (S1) S2 77.4-49290 2024-02-13T15:56:06.184Z
Sonos One (S13) S2 63.2-90210 2021-07-21T23:31:19.273Z
Sonos Beam (S14) S2 64.3-19080 2021-08-18T06:04:08.308Z
Sonos One (S18) S2 77.4-49290 2024-02-13T15:55:36.464Z
SYMFONISK Bookshelf (S21) S2 66.4-23300 2022-01-01T11:41:01.361Z
Sonos Roam (S27) S2 63.2-90210 2021-07-21T23:31:31.207Z
Sonos Play:3 (S3) S2 64.3-19080 2021-08-18T06:09:36.692Z
SYMFONISK Bookshelf (S33) S2 77.4-49290 2024-02-13T15:55:24.423Z
Sonos One SL (S38) S2 72.2-40060 2023-05-22T16:39:25.503Z
Sonos Play:5 (S6) S2 64.3-19080 2021-08-18T06:06:35.970Z
Sonos Playbar (S9) S2 77.4-49290 2024-02-13T15:55:46.307Z
Sonos Sub (Sub) S2 63.2-90210 2021-07-21T23:31:40.304Z