Link Search Menu Expand Document
Sonos API

MusicServicesService

External music services

The MusicServicesService is available on these models: v1-S1 / v1-S5 / v1-S9.

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

parameter type description
ServiceId ui4  
Username string  

Outputs:

parameter type description
SessionId string  

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:

parameter type description
AvailableServiceDescriptorList string  
AvailableServiceTypeList string  
AvailableServiceListVersion string  

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

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. A ❌ doesn’t mean that is won’t emit events.

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