The Sonos Control API is the primary means by which your application will interact with Sonos groups. First, discover available groups and players. Then use Control API commands to control players. For example, perform basic transport control such as play, pause, or skip. Or subscribe to receive events from the player, like track metadata.
Take listening to the next level with Sonos S2. This new version of the app enables higher resolution audio, with 24-bit processing and Dolby Atmos support. It also sports an improved design, better security, new features like saved room groups, and smarter software to keep your system up to date. Renamed the Sonos S1 Controller, this app supports systems that include the oldest Sonos products. Systems supported by this app will continue to receive bug fixes and security patches but will not receive new software features found in the new Sonos S2 app and will not be compatible with Sonos products released after May 2020.
The base URL is the API gateway to the Sonos cloud and the current version number:
api.ws.sonos.com/control/api/v1
See Control for details.
Click here to download the Sonos Desktop Controller for Mac Click here to download the Sonos Desktop Controller for PC Click here to download the Sonos Controller for iPhone Click here to download the Sonos Controller for iPad Alternatively, to download the Sonos Controller for iOS devices, search for Sonos in the App Store. Play YouTube on Sonos using AirPlay 2. If you have an Apple device, you're able to use AirPlay to wirelessly ping music over – kind of like Bluetooth or Wi-Fi streaming, but just for iPhone and iPad. Many Sonos speakers, including the Sonos One, Beam, Playbase, Move and the second-generation Play:5 all support AirPlay 2. The Sonos app will of course catch up and update to the track you're playing accordingly. Download on 7digital, stream on Sonos. It's not all about streaming services. Add your 7digital account details to the Sonos app and you can play all the music stored in your 7digital locker on Sonos. Buy new music on 7digital?
Here’s a grid of available namespaces and commands. Click a namespace or command for details. Click List View to see these commands in a list with URL paths.
audioClip
cancelAudioCliploadAudioClipsubscribeunsubscribe
favorites
getFavoritesloadFavoritesubscribeunsubscribe
groups
getGroupscreateGroupmodifyGroupMemberssetGroupMemberssubscribeunsubscribe
groupVolume
getVolumesetVolumesetRelativeVolumesetMutesubscribeunsubscribe
homeTheater
getOptionsloadHomeTheaterPlaybacksetOptionssetTvPowerState
playback
getPlaybackStatusloadLineInpauseplayseekseekRelativesetPlayModesskipToNextTrackskipToPreviousTracksubscribetogglePlayPauseunsubscribe
playbackMetadata
getMetadataStatussubscribeunsubscribe
playbackSession
createSessionjoinOrCreateSessionjoinSessionloadCloudQueueloadStreamUrlrefreshCloudQueueskipToItemseekseekRelativesubscribesuspendunsubscribe
playerVolume
getVolumesetVolumesetRelativeVolumesetMutesubscribeunsubscribe
playlists
getPlaylistgetPlaylistsloadPlaylistsubscribeunsubscribe
The sonos integration allows you to control your Sonos wireless speakers from Home Assistant. It also works with IKEA Symfonisk speakers.
You can configure the Sonos integration by going to the integrations page inside the configuration panel.
Services
The Sonos integration makes various custom services available.
Service sonos.snapshot
Take a snapshot of what is currently playing on one or more speakers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards. If no entity_id is provided, all speakers are snapshotted.
The queue is not snapshotted and must be left untouched until the restore. Using media_player.play_media is safe and can be used to play a notification sound, including TTS announcements.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | yes | The speakers to snapshot. To target all Sonos devices, use all. |
with_group | yes | Should we also snapshot the group layout and the state of other speakers in the group, defaults to true. |
Service sonos.restore
Restore a previously taken snapshot of one or more speakers. If no entity_id is provided, all speakers are restored.
The playing queue is not snapshotted. Using sonos.restore on a speaker that has replaced its queue will restore the playing position, but in the new queue!
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | yes | String or list of entity_ids that should have their snapshot restored. To target all Sonos devices, use all. |
with_group | yes | Should we also restore the group layout and the state of other speakers in the group, defaults to true. |
Service sonos.join
Group players together under a single coordinator. This will make a new group or join to an existing group.
| Service data attribute | Optional | Description |
|---|---|---|
master | no | A single entity_id that will become/stay the coordinator speaker. |
entity_id | yes | String or list of entity_ids to join to the master. |
Service sonos.unjoin
Remove one or more speakers from their group of speakers. If no entity_id is provided, all speakers are unjoined.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | yes | String or list of entity_ids to separate from their coordinator speaker. |
Service sonos.set_sleep_timer
Sets a timer that will turn off a speaker by tapering the volume down to 0 after a certain amount of time. Protip: If you set the sleep_time value to 0, then the speaker will immediately start tapering the volume down.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | yes | String or list of entity_ids that will have their timers set. |
sleep_time | no | Integer number of seconds that the speaker should wait until it starts tapering. Cannot exceed 86399 (one day). |
Service sonos.clear_sleep_timer
Clear the sleep timer on a speaker, if one is set.
Sonos Controller Download Windows 10
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | no | String or list of entity_ids that will have their timers cleared. Must be a coordinator speaker. |
Service sonos.update_alarm
Update an existing Sonos alarm.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | yes | String or list of entity_ids that will have their timers cleared. Must be a coordinator speaker. |
alarm_id | no | Integer that is used in Sonos to refer to your alarm. |
time | yes | Time to set the alarm. |
volume | yes | Float for volume level. |
enabled | yes | Boolean for whether or not to enable this alarm. |
include_linked_zones | yes | Boolean that defines if the alarm also plays on grouped players. |
Service sonos.set_option
Set Sonos speaker options.
Night Sound and Speech Enhancement modes are only supported when playing from the TV source of products like Sonos Playbar and Sonos Beam. Other speaker types will ignore these options.
Sonos Player Download Mac Pro
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | yes | String or list of entity_ids that will have their options set. |
night_sound | yes | Boolean to control Night Sound mode. |
speech_enhance | yes | Boolean to control Speech Enhancement mode. |
status_light | yes | Boolean to control the Status (LED) Light. |
Service sonos.play_queue
Starts playing the Sonos queue.
Force start playing the queue, allows switching from another stream (such as radio) to playing the queue.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | yes | String or list of entity_ids that will start playing. It must be the coordinator if targeting a group. |
queue_position | yes | Position of the song in the queue to start playing from, starts at 0. |
Service sonos.remove_from_queue
Removes an item from the queue.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id | yes | String or list of entity_ids that will remove an item from the queue. It must be the coordinator if targeting a group. |
queue_position | yes | Position in the queue to remove. |
Sonos Desktop Controller Download
Advanced use
For advanced uses, there are some manual configuration options available. Mass effect 3 pc digital download. These are usually only needed if you have a complex network setup where Home Assistant and Sonos are not on the same subnet.
Sonos Music Player Download
You can disable auto-discovery by specifying the Sonos IP addresses:
Sonos Desktop Controller
If your Home Assistant server has multiple IP addresses, you can provide the IP address that should be used for Sonos auto-discovery. This is rarely needed since all addresses should be tried by default.
Sonos App For Windows 10
The Sonos speakers will attempt to connect back to Home Assistant to deliver change events. By default, Home Assistant will listen on port 1400 but will try the next 100 ports above 1400 if it is in use. You can change the IP address that Home Assistant advertises to Sonos speakers. This can help in NAT scenarios such as when not using the Docker option --net=host: