Link Search Menu Expand Document
Sonos API

GroupManagementService

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

  1. Available actions
    1. AddMember
    2. RemoveMember
    3. ReportTrackBufferingResult
    4. SetSourceAreaIds
  2. Events
    1. Subscribe to events
    2. Event variables

Service data

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

Sample request 

POST /GroupManagement/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-upnp-org:service:GroupManagement: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

AddMember

Action body:

<u:AddMember xmlns:u="urn:schemas-upnp-org:service:GroupManagement:1">
  <MemberID>string</MemberID>
  <BootSeq>ui4</BootSeq>
</u:AddMember>

Inputs:

parameter type description
MemberID string  
BootSeq ui4  

Outputs:

parameter type description
CurrentTransportSettings string  
CurrentURI string  
GroupUUIDJoined string  
ResetVolumeAfter boolean  
VolumeAVTransportURI string  

RemoveMember

Action body:

<u:RemoveMember xmlns:u="urn:schemas-upnp-org:service:GroupManagement:1">
  <MemberID>string</MemberID>
</u:RemoveMember>

Inputs:

parameter type description
MemberID string  

ReportTrackBufferingResult

Action body:

<u:ReportTrackBufferingResult xmlns:u="urn:schemas-upnp-org:service:GroupManagement:1">
  <MemberID>string</MemberID>
  <ResultCode>i4</ResultCode>
</u:ReportTrackBufferingResult>

Inputs:

parameter type description
MemberID string  
ResultCode i4  

SetSourceAreaIds

Action body:

<u:SetSourceAreaIds xmlns:u="urn:schemas-upnp-org:service:GroupManagement:1">
  <DesiredSourceAreaIds>string</DesiredSourceAreaIds>
</u:SetSourceAreaIds>

Inputs:

parameter type description
DesiredSourceAreaIds string  

Events

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

Subscribe to events 

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

Event variables

Variable Sends events* type possible values
GroupCoordinatorIsLocal ✔ boolean  
LocalGroupUUID ✔ string  
ResetVolumeAfter ✔ boolean  
SourceAreaIds ❌ string  
VirtualLineInGroupID ✔ string  
VolumeAVTransportURI ✔ 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.