GroupManagement service

Services related to groups

The GroupManagement service is available on these models: 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 / Sonos Play:5 (S6) S2 / Sonos Sub (Sub) S2 / Sonos Play:1 (S1) S1 / Sonos Play:5 (S5) S1 / Sonos Playbar (S9) S1.

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

Service data

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:

Outputs:

RemoveMember

Action body:

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

Inputs:

ReportTrackBufferingResult

Action body:

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

Inputs:

SetSourceAreaIds

Action body:

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

Inputs:

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

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.