Get the Sonos queue

Use this action to get the contents of a Sonos speaker’s queue, for example to find a specific track and remove it, or to show what is coming up next.

This action returns its result in a response variable, which you can use in later steps of the same automation or script.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get the Sonos queue from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), pick the Sonos speaker you want to control. You can also select an area, a device, or a label.
6. From the actions shown for that target, select Get queue.
7. In the Response variable field, enter a name to store the queue data in, such as queue. You’ll use this name to read the queue in later steps.
8. Select Save.

Options in the UI

This action has no options.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as sonos.get_queue. Store the result in a response variable so you can use it in later steps:

action: sonos.get_queue
target:
  entity_id: media_player.living_room
response_variable: queue

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching media_player entity behind that target.

• Entity: one specific media_player entity, such as media_player.living_room.
• Device: every media_player entity that belongs to a device.
• Area: every media_player entity in a room or area.
• Floor: every media_player entity on a floor.
• Label: every media_player entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Response data

The action returns the queue for each speaker you targeted, keyed by the speaker’s entity ID. Each item in the list includes the following fields:

• media_title: The title of the track.
• media_album_name: The album the track belongs to.
• media_artist: The artist of the track.
• media_content_id: The content identifier of the track.

A shortened example of the response looks like this:

media_player.living_room:
  - media_title: Lazy Sunday
    media_album_name: Morning Coffee
    media_artist: The Beanery
    media_content_id: x-sonos-http:track%3a1234.mp3
  - media_title: Slow Down
    media_album_name: Morning Coffee
    media_artist: The Beanery
    media_content_id: x-sonos-http:track%3a5678.mp3

Good to know

• Use the Remove from the Sonos queue action together with this one to clear specific tracks. The example below gets the queue, loops through it in reverse order, and removes any track whose title or album contains the word “holiday”:

- action: sonos.get_queue
  target:
    entity_id: media_player.living_room
  response_variable: queue
- variables:
    queue_len: "{{ queue['media_player.living_room'] | length }}"
- repeat:
    sequence:
      - variables:
          title: "{{ queue['media_player.living_room'][queue_len - repeat.index]['media_title'].lower() }}"
          album: "{{ queue['media_player.living_room'][queue_len - repeat.index]['media_album_name'].lower() }}"
          position: "{{ queue_len - repeat.index }}"
      - if:
          - "{{ 'holiday' in title or 'holiday' in album }}"
        then:
          - action: sonos.remove_from_queue
            target:
              entity_id: media_player.living_room
            data:
              queue_position: "{{ position }}"
    until:
      - "{{ queue_len == repeat.index }}"

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Play the Sonos queue: Starts playing the Sonos queue, optionally from a specific position.

• Remove from the Sonos queue: Removes an item from a Sonos speaker’s queue.