The following section documents the various components that make up the HA Voice Assist support for this integration. It is not intended to be a guide for how to configure HA Voice Assist itself. If you are just getting started with HA voice, have a look at the Home Assistant Voice documentation to get started.

Use the following index to get you where you want to be.

• Intents Index
• Common Intent Responses
• Common Intent Slot Lists
• Common Intent Expansion Rules
• Installing Sentence Templates
  • User Slot List Customizations
• Exposing SpotifyPlus Media Player Entities

The following voice assist intents are provided by this integration.

• SpotifyPlusFavoriteAlbumAdd
• SpotifyPlusFavoriteAlbumRemove
• SpotifyPlusFavoriteArtistAdd
• SpotifyPlusFavoriteArtistRemove
• SpotifyPlusFavoriteAudiobookAdd
• SpotifyPlusFavoriteAudiobookRemove
• SpotifyPlusFavoritePlaylistAdd
• SpotifyPlusFavoritePlaylistRemove
• SpotifyPlusFavoritePodcastAdd
• SpotifyPlusFavoritePodcastRemove
• SpotifyPlusFavoritePodcastEpisodeAdd
• SpotifyPlusFavoritePodcastEpisodeRemove
• SpotifyPlusFavoriteTrackAdd
• SpotifyPlusFavoriteTrackRemove
• SpotifyPlusGetInfoArtistBio
• SpotifyPlusNowPlayingInfoArtistBio
• SpotifyPlusNowPlayingInfoAudiobook
• SpotifyPlusNowPlayingInfoPodcast
• SpotifyPlusNowPlayingInfoTrack
• SpotifyPlusPlayerMediaPause
• SpotifyPlusPlayerMediaResume
• SpotifyPlusPlayerMediaSkipNext
• SpotifyPlusPlayerMediaSkipPrevious
• SpotifyPlusPlayerMediaSkipStart
• SpotifyPlusPlayerSetRepeatMode
• SpotifyPlusPlayerSetShuffleMode
• SpotifyPlusPlayerSetVolumeLevel
• SpotifyPlusPlayerTransferPlayback
• SpotifyPlusPlayFavoriteTracks
• SpotifyPlusPlaylistCreate
• SpotifyPlusSearchPlayArtistAlbum
• SpotifyPlusSearchPlayArtistTrack
• SpotifyPlusSearchPlayAudiobook
• SpotifyPlusSearchPlayPlaylist
• SpotifyPlusSearchPlayPodcast
• SpotifyPlusSearchPlayPodcastEpisode
• SpotifyPlusSearchPlayTrack
• SpotifyPlusVolumeDown
• SpotifyPlusVolumeMuteOff
• SpotifyPlusVolumeMuteOn
• SpotifyPlusVolumeSetStep
• SpotifyPlusVolumeUp

end of intents index

Adds the currently playing track album to Spotify user album favorites.

How it Works
This intent calls the Save Album Favorites service to add the currently playing track album to the users' Spotify album favorites.

Example Phrases

• "add spotify album to favorites"
• "add spotify album favorite"
• "add spotify album favorite on player spotify premium"
• "add spotify album favorite on spotify premium player"
• "add spotify album favorite in the Office area"
• "add spotify album favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• album_title - The resolved Album name.
  Example: {text=Unseen: The Lion And The Lamb (Deluxe Edition), value=""}

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_album - if media player is not playing media that contains track album information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Removes the currently playing track album from Spotify user album favorites.

How it Works
This intent calls the Remove Album Favorites service to remove the currently playing track album from the users' Spotify album favorites.

Example Phrases

• "remove spotify album from favorites"
• "remove spotify album favorite"
• "remove spotify album favorite on player spotify premium"
• "remove spotify album favorite on spotify premium player"
• "remove spotify album favorite in the Office area"
• "remove spotify album favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• album_title - The resolved Album name.
  Example: {text=Unseen: The Lion And The Lamb (Deluxe Edition), value=""}

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_album - if media player is not playing media that contains track album information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Adds the currently playing track artist to Spotify user artist favorites.

How it Works
This intent calls the Follow Artists service to add the currently playing track artist to the users' Spotify artist favorites.

Example Phrases

• "add spotify artist to favorites"
• "add spotify artist favorite"
• "add spotify artist favorite on player spotify premium"
• "add spotify artist favorite on spotify premium player"
• "add spotify artist favorite in the Office area"
• "add spotify artist favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_artist - if media player is not playing media that contains track artist information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Removes the currently playing track artist from Spotify user artist favorites.

How it Works
This intent calls the Unfollow Artists service to remove the currently playing track artist from the users' Spotify artist favorites.

Example Phrases

• "remove spotify artist from favorites"
• "remove spotify artist favorite"
• "remove spotify artist favorite on player spotify premium"
• "remove spotify artist favorite on spotify premium player"
• "remove spotify artist favorite in the Office area"
• "remove spotify artist favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_artist - if media player is not playing media that contains track artist information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Adds the currently playing audiobook to Spotify user audiobook favorites.

How it Works
This intent calls the Save Audiobook Favorites service to add the currently playing audiobook to the users' Spotify audiobook favorites.

Example Phrases

• "add spotify audiobook to favorites"
• "add spotify audiobook favorite"
• "add spotify audiobook favorite on player spotify premium"
• "add spotify audiobook favorite on spotify premium player"
• "add spotify audiobook favorite in the Office area"
• "add spotify audiobook favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• audiobook_title - The resolved Audiobook name and URI value. Example: {text=The Elfstones of Shannara, value=spotify:show:74aydHJKgYz3AIq3jjBSv1}

• audiobook_url - External url that contains more information about the resolved audiobook.
  Example: {text=Spotify, value=https://open.spotify.com/show/74aydHJKgYz3AIq3jjBSv1}

• author_title - The resolved Audiobook author name. Example: {text=Terry Brooks, value=}

• chapter_title - The resolved Audiobook chapter name and URI value. Example: {text=Chapter 5, value=spotify:episode:3npL6aA9rshrP85Gl1EK1V}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_audiobook - if media player is not playing media that contains audiobook information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Removes the currently playing audiobook from Spotify user audiobook favorites.

How it Works
This intent calls the Remove Audiobook Favorites service to remove the currently playing audiobook from the users' Spotify audiobook favorites.

Example Phrases

• "remove spotify audiobook from favorites"
• "remove spotify audiobook favorite"
• "remove spotify audiobook favorite on player spotify premium"
• "remove spotify audiobook favorite on spotify premium player"
• "remove spotify audiobook favorite in the Office area"
• "remove spotify audiobook favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• audiobook_title - The resolved Audiobook name and URI value. Example: {text=The Elfstones of Shannara, value=spotify:show:74aydHJKgYz3AIq3jjBSv1}

• audiobook_url - External url that contains more information about the resolved audiobook.
  Example: {text=Spotify, value=https://open.spotify.com/show/74aydHJKgYz3AIq3jjBSv1}

• author_title - The resolved Audiobook author name. Example: {text=Terry Brooks, value=}

• chapter_title - The resolved Audiobook chapter name and URI value. Example: {text=Chapter 5, value=spotify:episode:3npL6aA9rshrP85Gl1EK1V}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_audiobook - if media player is not playing media that contains audiobook information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Adds the currently playing playlist to Spotify user playlist favorites.

How it Works
This intent calls the Follow Playlist service to add the currently playing playlist to the users' Spotify playlist favorites.

If the currently playing playlist contains Spotify generated content (e.g. "Daily Mix 01", artist radio, or other "Made For You" variants), then the playlist name will show as "Spotify Algorithmic Playlist". This is due to the fact that the Spotify Web Services API does not allow the playlist information to be queried.

Example Phrases

• "add spotify playlist to favorites"
• "add spotify playlist favorite"
• "add spotify playlist favorite on player spotify premium"
• "add spotify playlist favorite on spotify premium player"
• "add spotify playlist favorite in the Office area"
• "add spotify playlist favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

• public - True if playlist will be included in user's public playlists, false to remain private.
  Example: {value=true, text=yes}

Response Slot Parameters

• playlist_title - The resolved playlist name and URI value.
  Example: {value=spotify:playlist:657CDwrAnuLtPMMbergytH, text=Seventh Day Slumber: Essentials}

• playlist_url - External url that contains more information about the resolved playlist.
  Example: {value=https://open.spotify.com/playlist/x, text=Spotify}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_playlist - if media player is not playing media that contains playlist information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Removes the currently playing playlist from Spotify user playlist favorites.

How it Works
This intent calls the Unfollow Playlist service to remove the currently playing playlist from the users' Spotify playlist favorites.

If the currently playing playlist contains Spotify generated content (e.g. "Daily Mix 01", artist radio, or other "Made For You" variants), then the playlist name will show as "Spotify Algorithmic Playlist". This is due to the fact that the Spotify Web Services API does not allow the playlist information to be queried.

Example Phrases

• "remove spotify playlist from favorites"
• "remove spotify playlist favorite"
• "remove spotify playlist favorite on player spotify premium"
• "remove spotify playlist favorite on spotify premium player"
• "remove spotify playlist favorite in the Office area"
• "remove spotify playlist favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• playlist_title - The resolved playlist name and URI value.
  Example: {value=spotify:playlist:657CDwrAnuLtPMMbergytH, text=Seventh Day Slumber: Essentials}

• playlist_url - External url that contains more information about the resolved playlist.
  Example: {value=https://open.spotify.com/playlist/x, text=Spotify}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_playlist - if media player is not playing media that contains playlist information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Adds the currently playing podcast show to Spotify user podcast show favorites.

How it Works
This intent calls the Save Show Favorites service to add the currently playing podcast show to the users' Spotify podcast show favorites.

Example Phrases

• "add spotify podcast to favorites"
• "add spotify podcast favorite"
• "add spotify podcast favorite on player spotify premium"
• "add spotify podcast favorite on spotify premium player"
• "add spotify podcast favorite in the Office area"
• "add spotify podcast favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• podcast_title - The resolved Podcast show name and URI value.
  Example: {text=Armchair Expert with Dax Shepard, value=spotify:show:6kAsbP8pxwaU2kPibKTuHE}

• podcast_url - External url that contains more information about the resolved podcast show.
  Example: {text=Spotify, value=https://open.spotify.com/show/6kAsbP8pxwaU2kPibKTuHE}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.
  Use slot keys to convey more details (see the YAML file for this intent for an example).

• nowplaying_no_media_podcast - if media player is not playing media that contains podcast information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Removes the currently playing podcast show from Spotify user podcast show favorites.

How it Works
This intent calls the Remove Show Favorites service to remove the currently playing podcast show from the users' Spotify podcast show favorites.

Example Phrases

• "remove spotify podcast from favorites"
• "remove spotify podcast favorite"
• "remove spotify podcast favorite on player spotify premium"
• "remove spotify podcast favorite on spotify premium player"
• "remove spotify podcast favorite in the Office area"
• "remove spotify podcast favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• podcast_title - The resolved Podcast show name and URI value.
  Example: {text=Armchair Expert with Dax Shepard, value=spotify:show:6kAsbP8pxwaU2kPibKTuHE}

• podcast_url - External url that contains more information about the resolved podcast show.
  Example: {text=Spotify, value=https://open.spotify.com/show/6kAsbP8pxwaU2kPibKTuHE}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_podcast - if media player is not playing media that contains podcast information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Adds the currently playing podcast show episode to Spotify user podcast show episode favorites.

How it Works
This intent calls the Save Episode Favorites service to add the currently playing podcast show episode to the users' Spotify podcast show episode favorites.

Example Phrases

• "add spotify podcast episode to favorites"
• "add spotify podcast episode favorite"
• "add spotify podcast episode favorite on player spotify premium"
• "add spotify podcast episode favorite on spotify premium player"
• "add spotify podcast episode favorite in the Office area"
• "add spotify podcast episode favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• episode_title - The resolved Podcast episode name and URI value.
  Example: {text=Wyatt & Kurt Russell, value=spotify:episode:3F97boSWlXi8OzuhWClZHQ}

• episode_url - External url that contains more information about the resolved podcast episode.
  Example: {text=Spotify, value=https://open.spotify.com/episode/3F97boSWlXi8OzuhWClZHQ}

• podcast_title - The resolved Podcast show name and URI value.
  Example: {text=Armchair Expert with Dax Shepard, value=spotify:show:6kAsbP8pxwaU2kPibKTuHE}

• podcast_url - External url that contains more information about the resolved podcast show.
  Example: {text=Spotify, value=https://open.spotify.com/show/6kAsbP8pxwaU2kPibKTuHE}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_podcast - if media player is not playing media that contains podcast information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Removes the currently playing podcast show episode from Spotify user podcast show episode favorites.

How it Works
This intent calls the Remove Episode Favorites service to remove the currently playing podcast show episode from the users' Spotify podcast show episode favorites.

Example Phrases

• "remove spotify podcast episode from favorites"
• "remove spotify podcast episode favorite"
• "remove spotify podcast episode favorite on player spotify premium"
• "remove spotify podcast episode favorite on spotify premium player"
• "remove spotify podcast episode favorite in the Office area"
• "remove spotify podcast episode favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• episode_title - The resolved Podcast episode name and URI value.
  Example: {text=Wyatt & Kurt Russell, value=spotify:episode:3F97boSWlXi8OzuhWClZHQ}

• episode_url - External url that contains more information about the resolved podcast episode.
  Example: {text=Spotify, value=https://open.spotify.com/episode/3F97boSWlXi8OzuhWClZHQ}

• podcast_title - The resolved Podcast show name and URI value.
  Example: {text=Armchair Expert with Dax Shepard, value=spotify:show:6kAsbP8pxwaU2kPibKTuHE}

• podcast_url - External url that contains more information about the resolved podcast show.
  Example: {text=Spotify, value=https://open.spotify.com/show/6kAsbP8pxwaU2kPibKTuHE}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_podcast - if media player is not playing media that contains podcast information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Adds the currently playing track to Spotify user track favorites.

How it Works
This intent calls the Save Track Favorites service to add the currently playing track to the users' Spotify track favorites.

Example Phrases

• "add spotify track to favorites"
• "add spotify track favorite"
• "add spotify track favorite on player spotify premium"
• "add spotify track favorite on spotify premium player"
• "add spotify track favorite in the Office area"
• "add spotify track favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• track_title - The resolved Track name and URI value.
  Example: {text=I Need You, value=spotify:track:6zd8T1PBe9JFHmuVnurdRp}

• track_url - External url that contains more information about the resolved track.
  Example: {text=Spotify, value=https://open.spotify.com/track/6zd8T1PBe9JFHmuVnurdRp}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_track - if media player is not playing media that contains track information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Removes the currently playing track from Spotify user track favorites.

How it Works
This intent calls the Remove Track Favorites service to remove the currently playing track from the users' Spotify track favorites.

Example Phrases

• "remove spotify track from favorites"
• "remove spotify track favorite"
• "remove spotify track favorite on player spotify premium"
• "remove spotify track favorite on spotify premium player"
• "remove spotify track favorite in the Office area"
• "remove spotify track favorite in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• track_title - The resolved Track name and URI value.
  Example: {text=I Need You, value=spotify:track:6zd8T1PBe9JFHmuVnurdRp}

• track_url - External url that contains more information about the resolved track.
  Example: {text=Spotify, value=https://open.spotify.com/track/6zd8T1PBe9JFHmuVnurdRp}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default - if intent was successful.

• nowplaying_no_media_track - if media player is not playing media that contains track information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Get Spotify artist bio information for the specified artist name.
Up to 400 characters of information are returned (if bio was found).

How it Works
This intent calls the Search Artists service to find a matching artist.
It then calls the Get Artist Info service to retrieve bio information about the artist.

Example Phrases

• "spotify artist info for Phil Wickham"
• "get spotify artist info for Phil Wickham"
• "get spotify artist info for Phil Wickham on player spotify premium"
• "get spotify artist info for Phil Wickham on spotify premium player"
• "get spotify artist info for Phil Wickham in the Office area"
• "get spotify artist info for Phil Wickham in the Office"

Input Slot Parameters

• artist_name - Artist name search criteria (e.g. "Phil Wikham", "Journey", etc).

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_bio - Artist bio information; only returned if artist information contains a bio.
  Example: {text=Phil Wickham is a GRAMMY nominated artist ... value=}

• artist_title - The resolved Artist name and URI value.
  Example: {text=Phil Wickham, value=spotify:artist:5d1JhBfyb58upMXCZOdbQu}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/5d1JhBfyb58upMXCZOdbQu}

• search_criteria - The criteria used to search for the podcast episode.
  Example: {value=, text=artist:Phil Wickham}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• get_info_artist_bio - if intent was successful.

• nowplaying_no_media_artist - if media player is not playing media that contains Artist information.

• spotify_no_artist_info - if Spotify artist bio information was not found for the artist.

end of intent topic

Gets Spotify artist bio information for the currently playing track.
Up to 400 characters of information are returned (if bio was found).

How it Works
This intent calls the Get Artist Info service to retrieve bio information about the currently playing track artist.

Example Phrases

• "spotify nowplaying artist info"
• "spotify artist info"
• "get spotify artist info"
• "get spotify artist info on player spotify premium"
• "get spotify artist info on spotify premium player"
• "get spotify artist info in the Office area"
• "get spotify artist info in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_bio - Artist bio information; only returned if artist information contains a bio.
  Example: {text=Phil Wickham is a GRAMMY nominated artist ... value=}

• artist_title - The resolved Artist name and URI value.
  Example: {text=Phil Wickham, value=spotify:artist:5d1JhBfyb58upMXCZOdbQu}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/5d1JhBfyb58upMXCZOdbQu}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• get_info_artist_bio - if intent was successful.

• nowplaying_no_media_artist - if media player is not playing media that contains Artist information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

• spotify_no_artist_info - if Spotify artist bio information was not found for the artist.

end of intent topic

Gets Spotify information for the currently playing audiobook chapter.

How it Works
This intent queries exposed media player attributes that contain information about the currently playing audiobook.

Example Phrases

• "spotify nowplaying audiobook info"
• "spotify audiobook info"
• "get spotify audiobook info"
• "get spotify audiobook info on player spotify premium"
• "get spotify audiobook info on spotify premium player"
• "get spotify audiobook info in the Office area"
• "get spotify audiobook info in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• audiobook_title - The resolved Audiobook name and URI value. Example: {text=The Elfstones of Shannara, value=spotify:show:74aydHJKgYz3AIq3jjBSv1}

• audiobook_url - External url that contains more information about the resolved audiobook.
  Example: {text=Spotify, value=https://open.spotify.com/show/74aydHJKgYz3AIq3jjBSv1}

• author_title - The resolved Audiobook author name. Example: {text=Terry Brooks, value=}

• chapter_title - The resolved Audiobook chapter name and URI value. Example: {text=Chapter 5, value=spotify:episode:3npL6aA9rshrP85Gl1EK1V}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• nowplaying_info_audiobook - if intent was successful.

• nowplaying_no_media_audiobook - if media player is not playing media that contains Audiobook information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Gets Spotify information for the currently playing podcast episode.

How it Works
This intent queries exposed media player attributes that contain information about the currently playing podcast episode.

Example Phrases

• "spotify nowplaying podcast info"
• "spotify podcast info"
• "get spotify podcast info"
• "get spotify podcast info on player spotify premium"
• "get spotify podcast info on spotify premium player"
• "get spotify podcast info in the Office area"
• "get spotify podcast info in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• episode_title - The resolved Podcast episode name and URI value. Example: {text=Wyatt & Kurt Russell, value=spotify:episode:3F97boSWlXi8OzuhWClZHQ}

• episode_url - External url that contains more information about the resolved podcast episode.
  Example: {text=Spotify, value=https://open.spotify.com/episode/3F97boSWlXi8OzuhWClZHQ}

• podcast_title - The resolved Podcast show name and URI value.
  Example: {text=Armchair Expert with Dax Shepard, value=spotify:show:6kAsbP8pxwaU2kPibKTuHE}

• podcast_url - External url that contains more information about the resolved podcast show.
  Example: {text=Spotify, value=https://open.spotify.com/show/6kAsbP8pxwaU2kPibKTuHE}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• nowplaying_info_podcast - if intent was successful.

• nowplaying_no_media_podcast - if media player is not playing media that contains podcast information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Gets Spotify information for the currently playing track.

How it Works
This intent calls the Get Track service to retrieve information about the currently playing track.

Example Phrases

• "spotify nowplaying track info"
• "spotify track info"
• "get spotify track info"
• "get spotify track info on player spotify premium"
• "get spotify track info on spotify premium player"
• "get spotify track info in the Office area"
• "get spotify track info in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• album_title - The resolved Album name and URI value.
  Example: {text=Unseen: The Lion And The Lamb (Deluxe Edition), value=spotify:album:0LhYYU14RU6IPQ9vVMu3Yk}

• album_url - External url that contains more information about the resolved album.
  Example: {text=Spotify, value=https://open.spotify.com/album/0LhYYU14RU6IPQ9vVMu3Yk}

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• track_title - The resolved Track name and URI value.
  Example: {text=I Need You, value=spotify:track:6zd8T1PBe9JFHmuVnurdRp}

• track_url - External url that contains more information about the resolved track.
  Example: {text=Spotify, value=https://open.spotify.com/track/6zd8T1PBe9JFHmuVnurdRp}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• nowplaying_info_track - if intent was successful.

• nowplaying_no_media_track - if media player is not playing media that contains track information.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Pause media play for the specified SpotifyPlus media player.

How it Works
This intent calls the Player Media Pause service.

Example Phrases

• "spotify pause"
• "spotify pause track"
• "spotify pause the track"
• "spotify pause song"
• "spotify pause the song"
• "spotify stop"
• "spotify stop track"
• "spotify stop the track"
• "spotify stop song"
• "spotify stop the song"
• "spotify pause track on player spotify premium"
• "spotify pause track on spotify premium player"
• "spotify pause track in the Office area"
• "spotify pause track in the Office"

Input Slot Parameters

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

• player_not_playing_media - if media player state is not one of the following: playing.

end of intent topic

Resume media play for the specified SpotifyPlus media player.

How it Works
This intent calls the Player Media Resume service.

Example Phrases

• "spotify resume"
• "spotify resume play"
• "spotify resume player"
• "spotify resume track"
• "spotify resume song"
• "spotify start"
• "spotify start track"
• "spotify start song"
• "spotify start player"
• "spotify start play"
• "spotify resume song on player spotify premium"
• "spotify resume play on spotify premium player"
• "spotify resume track in the Office area"
• "spotify resume track in the Office"

Input Slot Parameters

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

• player_not_playing_media - if media player state is not one of the following: paused, off, on, idle, unknown.

end of intent topic

Skips to next track in the user's queue for the specified SpotifyPlus media player.

How it Works
This intent calls the Player Media Skip Next service.

Example Phrases

• "spotify next track"
• "spotify next song"
• "spotify play next track"
• "spotify play next song"
• "spotify play the next track"
• "spotify play the next song"
• "spotify skip to next track"
• "spotify skip to next song"
• "spotify skip to the next song"
• "spotify skip track"
• "spotify skip song"
• "spotify next track on player spotify premium"
• "spotify next track on spotify premium player"
• "spotify next track in the Office area"
• "spotify next track in the Office"

Input Slot Parameters

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Skips to previous track in the user's queue for the specified SpotifyPlus media player.

How it Works
This intent calls the Player Media Skip Previous service.

Example Phrases

• "spotify previous track"
• "spotify previous song"
• "spotify play previous track"
• "spotify play previous song"
• "spotify play the previous track"
• "spotify play the previous song"
• "spotify skip to previous track"
• "spotify skip to previous song"
• "spotify skip to the previous song"
• "spotify previous track on player spotify premium"
• "spotify previous track on spotify premium player"
• "spotify previous track in the Office area"
• "spotify previous track in the Office"

Input Slot Parameters

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Restarts the currently playing track for the specified SpotifyPlus media player.

How it Works
This intent calls the Player Media Seek service with a position value of zero to restart the track.

Example Phrases

• "spotify restart track"
• "spotify restart song"
• "spotify skip to start of track"
• "spotify skip to the start of the song"
• "spotify restart track on player spotify premium"
• "spotify restart track on spotify premium player"
• "spotify restart track in the Office area"
• "spotify restart track in the Office"

Input Slot Parameters

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Set repeat mode for the specified SpotifyPlus media player.

How it Works
This intent calls the Player Set Repeat Mode service.

Example Phrases

• "spotify repeat on"
• "spotify repeat track"
• "spotify repeat 1 track"
• "spotify repeat single track"
• "spotify repeat context"
• "spotify repeat all"
• "spotify repeat all tracks"
• "spotify repeat list"
• "spotify repeat off"
• "spotify repeat disabled"
• "spotify repeat track for player spotify premium"
• "spotify repeat track for spotify premium player"
• "spotify repeat track in the Office area"
• "spotify repeat track in the Office"

Input Slot Parameters

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• player_repeat_mode - The repeat mode to set. The player repeat mode slot list contains the allowed phrases.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Set shuffle mode for the specified SpotifyPlus media player.

How it Works
This intent calls the Player Set Shuffle Mode service.

Example Phrases

• "spotify shuffle mode on"
• "spotify shuffle mode off"
• "spotify shuffle on"
• "spotify shuffle off"
• "spotify shuffle enabled"
• "spotify shuffle disabled"
• "spotify shuffle mode on for player spotify premium"
• "spotify shuffle mode on for spotify premium player"
• "spotify shuffle mode on in the Office area"
• "spotify shuffle mode on in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• player_shuffle_mode - The shuffle mode to set. The player shuffle mode slot list contains the allowed phrases.

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

• player_not_playing_media - if media player state is not one of the following: playing, paused.

end of intent topic

Set volume level for the specified SpotifyPlus media player.

How it Works
This intent calls the Player Set Volume Level service.

Example Phrases

• "spotify volume level to 10 percent"
• "spotify volume level to 10 %"
• "spotify volume level 10 percent"
• "spotify volume 10 percent"
• "set spotify volume 10"
• "set spotify volume 10 percent for player spotify premium"
• "set spotify volume 10 percent for spotify premium player"
• "set spotify volume 10 percent in the Office area"
• "set spotify volume 10 percent in the Office"

Input Slot Parameters

• player_volume_level_pct - The volume level percentage to set. The player volume level pct slot list contains the allowed range.
  Example: {value=6, text=6}

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.
  Example: {value=0.5, text=0.5}

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

end of intent topic

Transfer playback to another Spotify Connect device name.

How it Works
This intent calls the Player Transfer Playback service to transfer playback to the specified device name.

Example Phrases

• "spotify transfer playback to device Bose-ST10-1"
• "spotify transfer playback to Bose-ST10-1"
• "spotify transfer playback Bose-ST10-1"
• "spotify transfer playback to Bose-ST10-1 for player spotify premium"
• "spotify transfer playback to Bose-ST10-1 in the Office area"

Input Slot Parameters

• device_name - The name of the Spotify Connect Player device this command is targeting. The device name slot list contains the allowed phrases (wildcard). The device names slot list is also used for a pre-defined list of source device names and their aliases (e.g. "Bose 1" for the "Bose-ST10-1" device, etc).

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

end of intent topic

Searches the Spotify catalog for a playlist name, and starts playing it if found.

How it Works
The Player Media Play Track Favorites service is called to play the user track favorites.
The filter_artist argument is used to optionally filter the list of favorites by the specified artist name freeform text, or from a artist names slot list entry.

Example Phrases

• "spotify play favorite tracks"
• "play spotify favorite tracks"
• "spotify play favorite tracks by artist Seventh Day Slumber"
• "play spotify favorite tracks by artist Seventh Day Slumber"
• "spotify play favorite tracks by artist Test Artist Slot Entry"
• "play spotify favorite tracks by artist Test Artist Slot Entry"
• "spotify play favorite tracks on player spotify premium"
• "play spotify favorite tracks on player spotify premium"
• "spotify play favorite tracks in the Office"
• "play spotify favorite tracks in the Office"

Input Slot Parameters

• artist_name - Artist name search criteria. The value can be freeform text (e.g. "Seventh Day Slumber", etc), or the artist names slot list can be used for a pre-defined list of commonly used artist name / URI values (e.g. "Journey", "Test Artist List Entry", etc).

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• device_name - The name (or id) of the Spotify Connect Player device this command is targeting. If an empty string is supplied, the user's currently active device is the target. If no device is active (or an '*' is specified), then the SpotifyPlus default device is activated.

• limit_total - The maximum number of items to retrieve from favorites. Default is 200; value range is 1 - 750.

• player_shuffle_mode - The player shuffle mode to set. The player shuffle mode slot list contains the allowed values.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_title - The resolved artist name and URI value.
  What is returned will depend on if artist name was supplied as an artist names slot list entry, freeform text, or not supplied. Example: {value=spotify:artist:6kFLnclYFc3gzpNt13wim5, text=test artist list entry} Example: {value=journey, text=journey} Example: {value=, text=}

• artist_url - External url that contains more information about the resolved playlist.
  What is returned will depend on if artist name was supplied as an artist names slot list entry, freeform text, or not supplied. Example: {value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5, text=Spotify} Example: {value=https://open.spotify.com, text=Spotify} Example: {value=https://open.spotify.com, text=Spotify}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• play_favorite_tracks - if intent was successful.

• play_favorite_tracks_for_artist - if intent was successful, and artist name criteria was specified.

end of intent topic

Creates a new empty playlist for the current user.

How it Works
The Playlist Create service is called to create the new playlist.

Example Phrases

• "spotify create playlist My New Playlist"
• "create spotify playlist My New Playlist"
• "spotify create playlist My New Playlist on player spotify premium"
• "create spotify playlist My New Playlist on player spotify premium"
• "spotify create playlist My New Playlist in the Office area"
• "create spotify playlist My New Playlist in the Office"

Input Slot Parameters

• playlist_name - Playlist name. If the specified name already exists, then a duplicate names is created (with no items).

      description: "Created by Home Assistant Voice Assist intent."
    is_collaborative: False
    is_public: False
    image_path: ""  # example: "www/spotifyplus/spotify_playlist_default_image.png"
  

• description - A description that describes the contents of the playlist.
  This is argument is not part of the sentence phrase; it must be overridden in the intent definition to use a default value.

• is_collaborative - If true, the playlist will be collaborative (other users can modify it). To create a collaborative playlist you must also set the public argument to false.
  This is argument is not part of the sentence phrase; it must be overridden in the intent definition to use a default value.

• is_public - If true, the playlist will be public; if false, it will be private.
  This is argument is not part of the sentence phrase; it must be overridden in the intent definition to use a default value.

• image_path - The fully-qualified path of the image to be uploaded (e.g. www/spotifyplus/spotify_playlist_default_image.png). The image must be in PNG or JPEG format, and cannot exceed 256KB in Base64 encoded size. Omit this parameter if you do not wish to add a playlist image.
  This is argument is not part of the sentence phrase; it must be overridden in the intent definition to use a default value.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• playlist_title - The resolved playlist name and URI value.
  Example: {value=spotify:playlist:1NI8srVxYtajbTX55utkK6, text=My New Playlist}

• playlist_url - External url that contains more information about the resolved playlist.
  Example: {value=https://open.spotify.com/playlist/1NI8srVxYtajbTX55utkK6, text=Spotify}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• playlist_created - if intent was successful.

end of intent topic

Searches the Spotify catalog for an album name by a specific artist, and starts playing it if found.

How it Works
This intent calls the Search Albums service to search for the specified album name.
If found, it then calls the Player Media Play Context service to play the first match returned.

Example Phrases

• "spotify play artist album Take Everything by artist Seventh Day Slumber"
• "play spotify artist album Take Everything by artist Seventh Day Slumber"
• "spotify play artist album Take Everything by artist Seventh Day Slumber on player spotify premium"
• "play spotify artist album Take Everything by artist Seventh Day Slumber on player spotify premium"
• "spotify play artist album Take Everything by artist Seventh Day Slumber in the Office"
• "play spotify artist album Take Everything by artist Seventh Day Slumber in the Office"

Input Slot Parameters

• album_name - Album name search criteria (e.g. "Lion and the Lamb Deluxe Edition", "Greatest Hits", etc).

• artist_name - Artist name search criteria (e.g. "Seventh Day Slumber", "Journey", etc).

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• device_name - The name (or id) of the Spotify Connect Player device this command is targeting. If an empty string is supplied, the user's currently active device is the target. If no device is active (or an '*' is specified), then the SpotifyPlus default device is activated.

• player_shuffle_mode - The player shuffle mode to set. The player shuffle mode slot list contains the allowed values.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• album_title - The resolved Album name.
  Example: {text=Unseen: The Lion And The Lamb (Deluxe Edition), value=""}

• album_url - External url that contains more information about the resolved album.
  Example: {text=Spotify, value=https://open.spotify.com/track/6zd8T1PBe9JFHmuVnurdRp}

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• search_criteria - The criteria used to search for the podcast episode.
  Example: {value=, text=Take Everything artist:Seventh Day Slumber}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• play_album_with_artist - if intent was successful.

• spotify_search_no_items_album - if the Spotify catalog search yielded no matches.

end of intent topic

Searches the Spotify catalog for a track name by a specific artist, and starts playing it if found.

How it Works
This intent calls the Search Tracks service to search for the specified track name.
If found, it then calls the Player Media Play Tracks service to play the first match returned.

Example Phrases

• "spotify play artist track I Need You by artist Seventh Day Slumber"
• "play spotify artist track I Need You by artist Seventh Day Slumber"
• "spotify play artist track I Need You by artist Seventh Day Slumber on player spotify premium"
• "play spotify artist track I Need You by artist Seventh Day Slumber on player spotify premium"
• "spotify play artist track I Need You by artist Seventh Day Slumber in the Office"
• "play spotify artist track I Need You by artist Seventh Day Slumber in the Office"

Input Slot Parameters

• track_name - Track name search criteria (e.g. "I Need You", "Don't Stop Believing", etc).

• artist_name - Artist name search criteria (e.g. "Seventh Day Slumber", "Journey", etc).

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• device_name - The name (or id) of the Spotify Connect Player device this command is targeting. If an empty string is supplied, the user's currently active device is the target. If no device is active (or an '*' is specified), then the SpotifyPlus default device is activated.

• player_shuffle_mode - The player shuffle mode to set. The player shuffle mode slot list contains the allowed values.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• track_title - The resolved Track name and URI value.
  Example: {text=I Need You, value=spotify:track:6zd8T1PBe9JFHmuVnurdRp}

• track_url - External url that contains more information about the resolved track.
  Example: {text=Spotify, value=https://open.spotify.com/track/6zd8T1PBe9JFHmuVnurdRp}

• search_criteria - The criteria used to search for the podcast episode.
  Example: {value=, text=I Need You artist:Seventh Day Slumber}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• play_track_with_artist - if intent was successful.

• spotify_search_no_items_track - if the Spotify catalog search yielded no matches.

end of intent topic

Searches the Spotify catalog for an audiobook name, and starts playing it if found.

How it Works
If the audiobook_name is resolved from a audiobook names slot list entry, then it calls the Player Media Play Context service to play the content.

If the audiobook_name is freeform text, then it calls the Search Audiobooks service to search for the specified audiobook name.
If found, it then calls the Player Media Play Context service to play the first match returned.

Example Phrases

• "spotify play audiobook The Elfstones of Shannara"
• "play spotify audiobook The Elfstones of Shannara"
• "spotify play audiobook Test Book List Entry"
• "play spotify audiobook Test Book List Entry"
• "spotify play audiobook The Elfstones of Shannara on player spotify premium"
• "play spotify audiobook The Elfstones of Shannara on player spotify premium"
• "spotify play audiobook The Elfstones of Shannara in the Office area"
• "spotify play audiobook The Elfstones of Shannara in the Office"

Input Slot Parameters

• audiobook_name - Audiobook name search criteria. The value can be freeform text (e.g. "The Elfstones of Shannara", "Dune", etc), or the audiobook names slot list can be used for a pre-defined list of commonly used audiobook name / URI values.

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• device_name - The name (or id) of the Spotify Connect Player device this command is targeting. If an empty string is supplied, the user's currently active device is the target. If no device is active (or an '*' is specified), then the SpotifyPlus default device is activated.

• player_shuffle_mode - The player shuffle mode to set. The player shuffle mode slot list contains the allowed values.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• audiobook_title - The resolved Audiobook name.
  Example: {value=spotify:show:74aydHJKgYz3AIq3jjBSv1, text=The Elfstones of Shannara}

• audiobook_url - External url that contains more information about the resolved audiobook.
  Example: {value=https://open.spotify.com/show/74aydHJKgYz3AIq3jjBSv1, text=Spotify}

• author_title - The author name of the resolved Audiobook.
  Example: {text=Terry Brooks, value=Terry Brooks}

• search_criteria - The criteria used to search for the podcast episode.
  Example: {value=, text=The Elfstones of Shannara}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• play_audiobook_with_author - if intent was successful.

• play_audiobook - if intent was successful, and the audiobook_name was resolved from a audiobook names slot list entry.

• spotify_search_no_items_album - if the Spotify catalog search yielded no matches.

end of intent topic

Searches the Spotify catalog for a playlist name, and starts playing it if found.

How it Works
If the playlist_name is resolved from a playlist names slot list entry, then it calls the Player Media Play Context service to play the content.

If the playlist_name is freeform text, then it calls the Search Playlists service to search for the specified playlist name.
If found, it then calls the Player Media Play Context service to play the first match returned.

Example Phrases

• "spotify play playlist Daily Mix 1"
• "spotify play playlist Seventh Day Slumber"
• "play spotify playlist Daily Mix 1"
• "play spotify playlist Seventh Day Slumber"
• "spotify play playlist Daily Mix 1 on player spotify premium"
• "play spotify playlist Daily Mix 1 on player spotify premium"
• "spotify play playlist Daily Mix 1 in the Office"
• "play spotify playlist Daily Mix 1 in the Office"

Input Slot Parameters

• playlist_name - Playlist name search criteria. The value can be freeform text (e.g. "My Playlist", etc), or the playlist names slot list can be used for a pre-defined list of commonly used playlist name / URI values (e.g. "Daily Mix 1", "Discover Weekly", etc).

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• device_name - The name (or id) of the Spotify Connect Player device this command is targeting. If an empty string is supplied, the user's currently active device is the target. If no device is active (or an '*' is specified), then the SpotifyPlus default device is activated.

• player_shuffle_mode - The player shuffle mode to set. The player shuffle mode slot list contains the allowed values.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• playlist_title - The resolved playlist name and URI value.
  Example: {value=spotify:playlist:657CDwrAnuLtPMMbergytH, text=Seventh Day Slumber: Essentials}

• playlist_url - External url that contains more information about the resolved playlist.
  Example: {value=https://open.spotify.com/playlist/x, text=Spotify}

• search_criteria - The criteria used to search for the podcast episode.
  Example: {value=, text=Seventh Day Slumber Essentials}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• play_playlist - if intent was successful.

• spotify_search_no_items_playlist - if the Spotify catalog search yielded no matches.

end of intent topic

Searches the Spotify catalog for a podcast name, and starts playing it if found.

How it Works
If the podcast_name is resolved from a podcast names slot list entry, then it calls the Player Media Play Context service to play the content.

If the podcast_name is freeform text, then it calls the Search Shows service to search for the specified podcast name.
If found, it then calls the Player Media Play Context service to play the first match returned.

Example Phrases

• "spotify play podcast Armchair Expert"
• "spotify play podcast Test Podcast List"
• "play spotify podcast Armchair Expert"
• "play spotify podcast Test Podcast List"
• "spotify play podcast Armchair Expert on player spotify premium"
• "play spotify podcast Armchair Expert on player spotify premium"
• "spotify play podcast Armchair Expert in the Office area"
• "play spotify podcast Armchair Expert in the Office"

Input Slot Parameters

• podcast_name - Podcast name search criteria. The value can be freeform text (e.g. "Armchair Expert", etc), or the podcast names slot list can be used for a pre-defined list of commonly used podcast name / URI values.

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• device_name - The name (or id) of the Spotify Connect Player device this command is targeting. If an empty string is supplied, the user's currently active device is the target. If no device is active (or an '*' is specified), then the SpotifyPlus default device is activated.

• latest_episode - Determines if the latest episode in the podcast is played from the start (on), or if the last played podcast is to resume from where it was previously paused (off). Default is on.

• player_shuffle_mode - The player shuffle mode to set. The player shuffle mode slot list contains the allowed values.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• podcast_title - The resolved podcast name and URI value.
  Example: {value=spotify:show:6kAsbP8pxwaU2kPibKTuHE, text=Armchair Expert with Dax Shepard}

• podcast_url - External url that contains more information about the resolved podcast.
  Example: {value=https://open.spotify.com/show/6kAsbP8pxwaU2kPibKTuHE, text=Spotify}

• episode_title - The resolved podcast episode name and URI value.
  Example: {value=spotify:episode:6JUsG5CfTNDFVNaTXZEqaC, text=Armchair Anonymous: Military}

• episode_url - External url that contains more information about the resolved podcast episode.
  Example: {value=https://open.spotify.com/episode/6JUsG5CfTNDFVNaTXZEqaC, text=Spotify}

• search_criteria - The criteria used to search for the podcast episode.
  Example: {value=, text=Armchair Expert}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• play_podcast - if intent was successful, and the latest episode started playing.

• play_podcast_episode - if intent was successful, and play was resumed for an existing episode.

• spotify_search_no_items_podcast - if the Spotify catalog search yielded no matches.

end of intent topic

Searches the Spotify catalog for a podcast episode name, and starts playing it if found.

How it Works
This intent calls the Search Episodes service to search for the specified podcast episode name.
If found, it then calls the Get Episode service to retrieve the parent podcast details.
It then calls the Player Media Play Tracks service to play the episode.

Example Phrases

• "spotify play episode Kurt Russell for podcast Armchair Expert"
• "play spotify episode Kurt Russell for podcast Armchair Expert"
• "spotify play episode Kurt Russell for podcast Armchair Expert on player spotify premium"
• "play spotify episode Kurt Russell for podcast Armchair Expert on player spotify premium"
• "spotify play episode Kurt Russell for podcast Armchair Expert in the Office"
• "play spotify episode Kurt Russell for podcast Armchair Expert in the Office"

Input Slot Parameters

• podcast_name - Podcast name search criteria.

• episode_name - Podcast Episode name search criteria.

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• device_name - The name (or id) of the Spotify Connect Player device this command is targeting. If an empty string is supplied, the user's currently active device is the target. If no device is active (or an '*' is specified), then the SpotifyPlus default device is activated.

• player_shuffle_mode - The player shuffle mode to set. The player shuffle mode slot list contains the allowed values.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• podcast_title - The resolved podcast name and URI value.
  Example: {value=spotify:show:6kAsbP8pxwaU2kPibKTuHE, text=Armchair Expert with Dax Shepard}

• podcast_url - External url that contains more information about the resolved podcast.
  Example: {value=https://open.spotify.com/show/6kAsbP8pxwaU2kPibKTuHE, text=Spotify}

• episode_title - The resolved podcast episode name and URI value.
  Example: {value=spotify:episode:6JUsG5CfTNDFVNaTXZEqaC, text=Armchair Anonymous: Military}

• episode_url - External url that contains more information about the resolved podcast episode.
  Example: {value=https://open.spotify.com/episode/6JUsG5CfTNDFVNaTXZEqaC, text=Spotify}

• search_criteria - The criteria used to search for the podcast episode.
  Example: {value=, text=Armchair Anonymous Military, Armchair Expert}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• play_podcast_episode - if intent was successful.

• spotify_search_no_items_podcast_episode - if the Spotify catalog search yielded no matches.

end of intent topic

Searches the Spotify catalog for a track name, and starts playing it if found.

How it Works
If the track_name is resolved from a track names slot list entry, then it calls the Player Media Play Context service to play the content.

If the track_name is freeform text, then it calls the Search Tracks service to search for the specified track name.
If found, it then calls the Player Media Play Tracks service to play the first match returned.

Example Phrases

• "spotify play track I Need You"
• "play spotify track I Need You"
• "spotify play track I Need You on player spotify premium"
• "play spotify track I Need You on player spotify premium"
• "spotify play track I Need You in the Office"
• "play spotify track I Need You in the Office"

Input Slot Parameters

• track_name - Track name search criteria. The value can be freeform text (e.g. "I Need You", "Don't Stop Believing", etc), or the track names slot list can be used for a pre-defined list of commonly used track name / URI values.

• artist_name - Artist name search criteria (e.g. "Seventh Day Slumber", "Journey", etc).

• delay - Time delay (in seconds) to wait AFTER issuing a service call to a SpotifyPlus media player service. This delay will give the spotify web api time to process the change before another service command is issued. Default is 0.50; value range is 0 - 10.

• device_name - The name (or id) of the Spotify Connect Player device this command is targeting. If an empty string is supplied, the user's currently active device is the target. If no device is active (or an '*' is specified), then the SpotifyPlus default device is activated.

• player_shuffle_mode - The player shuffle mode to set. The player shuffle mode slot list contains the allowed values.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• artist_title - The resolved Artist name and URI value.
  Example: {text=Seventh Day Slumber, value=spotify:artist:6kFLnclYFc3gzpNt13wim5}

• artist_url - External url that contains more information about the resolved artist.
  Example: {text=Spotify, value=https://open.spotify.com/artist/6kFLnclYFc3gzpNt13wim5}

• track_title - The resolved Track name and URI value.
  Example: {text=I Need You, value=spotify:track:6zd8T1PBe9JFHmuVnurdRp}

• track_url - External url that contains more information about the resolved track.
  Example: {text=Spotify, value=https://open.spotify.com/track/6zd8T1PBe9JFHmuVnurdRp}

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• play_track - if intent was successful.

• spotify_search_no_items_track - if the Spotify catalog search yielded no matches.

end of intent topic

Decrease volume by the specified volume step level amount for the specified SpotifyPlus media player.

How it Works
This intent calls the HA media_player Volume Down service.

Example Phrases

• "spotify player volume level down"
• "spotify player volume level decrease"
• "spotify volume level decrease"
• "spotify volume decrease"
• "spotify volume down"
• "decrease spotify player volume level"
• "decrease spotify player volume"
• "decrease spotify volume"
• "lower spotify volume"
• "spotify volume decrease for player spotify premium"
• "spotify volume decrease for spotify premium player"
• "spotify volume decrease in the Office area"
• "spotify volume decrease in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

end of intent topic

Unmute (restore) volume for the specified SpotifyPlus media player.

How it Works
This intent calls the HA media_player Volume Mute service with is_volume_muted set to False.

Example Phrases

• "spotify unmute player volume level"
• "spotify unmute player volume"
• "spotify unmute player"
• "spotify unmute"
• "unmute spotify player volume level"
• "unmute spotify player volume"
• "unmute spotify player"
• "unmute spotify"
• "spotify unmute for player spotify premium"
• "spotify unmute for spotify premium player"
• "spotify unmute in the Office area"
• "spotify unmute in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

end of intent topic

Mute volume for the specified SpotifyPlus media player.

How it Works
This intent calls the HA media_player Volume Mute service with is_volume_muted set to True.

Example Phrases

• "spotify mute player volume level"
• "spotify mute player volume"
• "spotify mute player"
• "spotify mute"
• "mute spotify player volume level"
• "mute spotify player volume"
• "mute spotify player"
• "mute spotify"
• "spotify mute volume for player spotify premium"
• "spotify mute volume for spotify premium player"
• "spotify mute volume in the Office area"
• "spotify mute volume in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

end of intent topic

Set level used for volume step services for the specified SpotifyPlus media player.

How it Works
This intent calls the Volume Set Step Level service.

Example Phrases

• "spotify volume step level to 10 percent"
• "spotify volume step level to 10 %"
• "spotify volume step level 10 percent"
• "spotify volume step 10 percent"
• "spotify volume step level to 10 percent for player spotify premium"
• "spotify volume step level to 10 percent for spotify premium player"
• "spotify volume step level to 10 percent in the Office area"
• "spotify volume step level to 10 percent in the Office"

Input Slot Parameters

• player_volume_step_pct - The allowed percentage range of the volume step value (1-100). The player volume step pct slot list contains the allowed ranges.

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

end of intent topic

Increase volume by the specified volume step level amount for the specified SpotifyPlus media player.

How it Works
This intent calls the HA media_player Volume Up service.

Example Phrases

• "spotify player volume level up"
• "spotify player volume level increase"
• "spotify volume level increase"
• "spotify volume increase"
• "spotify volume up"
• "increase spotify player volume level"
• "increase spotify player volume"
• "increase spotify volume"
• "raise spotify volume"
• "spotify volume down for player spotify premium"
• "spotify volume down for spotify premium player"
• "spotify volume down in the Office area"
• "spotify volume down in the Office"

Input Slot Parameters

• name - Media player name (or alias) of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player name expansion rule was inferred, or if a default player name was implied.

• area - Area name of the SpotifyPlus media player entity that will process the request. This slot is optional, and is only used if the player area expansion rule was inferred.

Response Slot Parameters

• target_player - The media player that was resolved from the specified name / area / default player value.
  Example: {text=Spotify Premium, value=media_player.spotifyplus_todd_l}

Responses

• default_no_player - if intent was successful for the default media player.

• default_by_name - if intent was successful for the named media player.

• default_by_area - if intent was successful for the area media player.

end of intent topic

The following responses are shared among all intent definitions.

These definitions can be found in the spotifyplus_common_<lang>.yaml file, where <lang> is the language code (e.g. en for English, etc).

Messages that relate to media player information queries.
Use slot keys of the calling intent to convey details in the response (see the common YAML file for an example).

• get_info_artist_bio Response

  Returned when artist bio information was retrieved successfully.

Messages that relate to media player selection.
Use slot keys of the calling intent to convey details in the response (see the common YAML file for an example).

• play_album_with_artist Response

  Returned when an album name by a specific artist was resolved and started playing on the specified media player.

• play_album Response

  Returned when an album name was resolved and started playing on the specified media player.

• play_audiobook Response

  Returned when an audiobook name was resolved and started playing on the specified media player.

• play_audiobook_with_author Response

  Returned when an audiobook name by a specific author was resolved and started playing on the specified media player.

• play_favorite_tracks Response

  Returned when a users favorite tracks are started playing on a specified media player.

• play_favorite_tracks_for_artist Response

  Returned when a users favorite tracks for an artist name are started playing on a specified media player.

• play_playlist Response

  Returned when a playlist name was resolved and started playing on a specified media player.

• play_podcast Response

  Returned when a podcast name was resolved and started playing on a specified media player.

• play_podcast_episode Response

  Returned when a podcast episode name was resolved and started playing on a specified media player.

• play_track_with_artist Response

  Returned when a track name by a specific artist was resolved and started playing on the specified media player.

• play_track Response

  Returned when a track name was resolved and started playing on the specified media player.

• player_features_not_supported Response

  Returned when the resolved media player does not support the feature the intent is requesting.
  For example, Spotify Free account is not allowed to request player transport functions; this message will be returned in that case, since the Free account cannot control the player.

• player_not_exposed_to_voice Response

  Returned when the resolved media player has not been exposed to Voice Assistant.
  Check out the Exposing Media Player Entities section for how to correct this.

• player_not_matched Response

  Returned when the intent could not resolve a SpotifyPlus media player by the specified player name, alias(es), or it's specific entity_id value (e.g. "Spotify Premium", "Todds Player", etc).

• player_not_matched_area Response

  Returned when the intent could not resolve a SpotifyPlus media player by the specified area name (e.g. "Living Room", "Kitchen", etc).

• player_not_playing_media Response

  Returned when the intent requires that media be playing, but the specified (or default) player is currently not playing anything. The current state of the player must be playing or idle.
  Use the Developer Tools \ States to check the current state of the specified player.

• player_not_spotifyplus Response

  Returned when the resolved media player is not a SpotifyPlus media player. A SpotifyPlus media player instance is required in order to call the underlying service that processes the intended function.

• playlist_created Response

  Returned when a new playlist has been created.

Messages that relate to media player now-playing information.
Use slot keys of the calling intent to convey details in the response (see the common YAML file for an example).

• nowplaying_info_audiobook Response

  Returned when now-playing audiobook information was retrieved successfully.

• nowplaying_info_podcast Response

  Returned when now-playing podcast information was retrieved successfully.

• nowplaying_info_track Response

  Returned when now-playing track information was retrieved successfully.

• nowplaying_no_media_album Response

  Returned when the resolved media player is currently not playing media that contains Track Album information.

• nowplaying_no_media_artist Response

  Returned when the resolved media player is currently not playing media that contains Track Artist information.

• nowplaying_no_media_audiobook Response

  Returned when the resolved media player is currently not playing media that contains Audiobook information.

• nowplaying_no_media_episode Response

  Returned when the resolved media player is currently not playing media that contains Episode information.

• nowplaying_no_media_playlist Response

  Returned when the resolved media player is currently not playing media that contains Playlist information.

• nowplaying_no_media_podcast Response

  Returned when the resolved media player is currently not playing media that contains Podcast information.

• nowplaying_no_media_track Response

  Returned when the resolved media player is currently not playing media that contains Track information.

Messages that relate to processing Spotify requests.
Use slot keys of the calling intent to convey details in the response (see the common YAML file for an example).

• spotify_no_artist_info Response

  Returned when Artist information could not be found for the specified criteria.

• spotify_search_no_items_album Response

  Returned when no matches were returned after searching the Spotify catalog for the specified album name.

• spotify_search_no_items_playlist Response

  Returned when no matches were returned after searching the Spotify catalog for the specified playlist name.

• spotify_search_no_items_podcast Response

  Returned when no matches were returned after searching the Spotify catalog for the specified podcast name.

• spotify_search_no_items_podcast_episode Response

  Returned when no matches were returned after searching the Spotify catalog for the specified podcast episode name.

• spotify_search_no_items_track Response

  Returned when no matches were returned after searching the Spotify catalog for the specified track name.

• spotify_premium_required Response

  Returned when the requested intent cannot be fulfilled because the resolved media player does not support Spotify Premium account features.

The following slot lists are shared among all intent definitions.

• album_name Slot List

  Contains the allowed album name values.
  This value is a wildcard, and can match on anything.

  album_name:
    wildcard: true  # Wildcard lists can match any text.
  

• artist_name Slot List

  Contains the allowed artist name values.
  This value is a wildcard, and can match on anything.

  artist_name:
    wildcard: true  # Wildcard lists can match any text.
  

• audiobook_name Slot List

  Contains the allowed audiobook name values.
  This value is a wildcard, and can match on anything.

  audiobook_name:
    wildcard: true  # Wildcard lists can match any text.
  

• device_name Slot List

  Contains the allowed Spotify Connect device (i.e. remote) name values.
  This value is a wildcard, and can match on anything.

  device_name:
    wildcard: true  # Wildcard lists can match any text.
  

• episode_name Slot List

  Contains the allowed podcast episode name values.
  This value is a wildcard, and can match on anything.

  episode_name:
    wildcard: true  # Wildcard lists can match any text.
  

• playlist_name Slot List

  Contains the allowed playlist name values.
  This value is a wildcard, and can match on anything.

  playlist_name:
    wildcard: true  # Wildcard lists can match any text.
  

• podcast_name Slot List

  Contains the allowed podcast name values.
  This value is a wildcard, and can match on anything.

  podcast_name:
    wildcard: true  # Wildcard lists can match any text.
  

• track_name Slot List

  Contains the allowed track name values.
  This value is a wildcard, and can match on anything.

  track_name:
    wildcard: true  # Wildcard lists can match any text.
  

• player_repeat_mode Slot List

  Contains the allowed media player repeat modes.
  Out value must be one of the following: track, context, off.

  player_repeat_mode:
    values:
      - in: "(on|[single|1|one] track|)"
        out: "track"
      - in: "(context|all|all tracks|list)"
        out: "context"
      - in: "(off|disable[d])"
        out: "off"
  

• player_shuffle_mode Slot List

  Contains the allowed media player shuffle modes.
  Out value must be one of the following: on, off.

  player_shuffle_mode:
    values:
      - in: "(on|true|enable[d])"
        out: "on"
      - in: "(off|false|disable[d])"
        out: "off"
  

• player_volume_level Slot List

  Contains the allowed media player volume levels.
  Out value must be a number in the range of 0 to 100.

  player_volume_level:
    values:
      - in: (max|maximum|highest)
        out: 100
      - in: (min|minimum|lowest)
        out: 1
  

• player_volume_level_pct Slot List

  Contains the allowed media player volume level percentage range.

  player_volume_level_pct:
    range:
      type: "percentage"
      from: 1
      to: 100
  

• player_volume_step_pct Slot List

  Contains the allowed media player volume step level percentage range.

  player_volume_step_pct:
    range:
      type: "percentage"
      from: 1
      to: 100
  

• spotifyplus_album_names Slot List

  This list is used primarily to identify Spotify Albums that either get misinterpreted when a spoken phrase is used, or if you want a specific album of multiple album renditions. For example, do you want Journey's original 1981 version of the "Escape" album tour, or the 2022 remastered version?

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly album identifiers.
  #
  # This list is used primarily to identify Spotify Albums that either get misinterpreted
  # when a spoken phrase is used, or if you want a specific album of multiple album
  # renditions.  For example, do you want Journey's original 1981 version of the 
  # "Escape" album tour, or the 2022 remastered version?
  #
  #  in: Voice friendly identifier.
  # out: Spotify album uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_album_names:
    values:
      - in: "Escape"
        out: "spotify:album:4guAwaniEAEQSW0NCpo4gm" # Journey, 2022 Remaster
      - in: "Escape 1981"
        out: "spotify:album:0gHmMKZ9s3ztqeMfAzwxRL" # Journey, 1981 Live, Escape Tour
  

• spotifyplus_audiobook_names Slot List

  This list is used primarily to identify Spotify Audiobooks that either get misinterpreted when a spoken phrase is used, or if you want a specific audiobook of multiple audiobook renditions.

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly audiobook identifiers.
  #
  # This list is used primarily to identify Spotify Audiobooks that either get misinterpreted
  # when a spoken phrase is used, or if you want a specific audiobook of multiple audiobook
  # renditions.
  #
  #  in: Voice friendly identifier.
  # out: Spotify audiobook uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_audiobook_names:
    values:
      - in: "Test Book List Entry"
        out: "spotify:show:74aydHJKgYz3AIq3jjBSv1" # The Elfstones of Shannara
  

• spotifyplus_device_names Slot List

  This list is used to identify Spotify Connect device names.
  These should align with what's in the source_list attribute of the media player.

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly device name identifiers.
  #
  # This list is used to identify Spotify Connect device names.
  # These should align with what's in the `source_list` attribute of the media player.
  #
  #  in: Voice friendly identifier.
  # out: SpotifyPlus media_player source_list entry.
  # --------------------------------------------------------------------------------------
  spotifyplus_device_names:
    values:
      - in: "Office"
        out: "Office Speaker"
  
  

• spotifyplus_playlist_names Slot List

  This list is used primarily to identify Spotify Algorithmic Playlists, which cannot be returned by the Spotify Web API due to the 2024/11/27 Deprecation Event.

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly playlist identifiers.
  #
  # This list is used primarily to identify Spotify Algorithmic Playlists, which
  # cannot be returned by the Spotify Web API as of 2024/11/27.
  # More info: https://developer.spotify.com/blog/2024-11-27-changes-to-the-web-api
  #
  #  in: Voice friendly identifier.
  # out: Spotify playlist uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_playlist_names:
    values:
      - in: "Daily Mix (1|One)"
        out: "spotify:playlist:37i9dQZF1E39vTG3GurFPW"
      - in: "Daily Mix (2|Two)"
        out: "spotify:playlist:37i9dQZF1E39DIjrju3A9t"
      - in: "Daily Mix (3|Three)"
        out: "spotify:playlist:37i9dQZF1E36yv9pXdC1Mb"
      - in: "Daily Mix (4|Four)"
        out: "spotify:playlist:37i9dQZF1E35Ejqg6yJW0p"
      - in: "Daily Mix (5|Five)"
        out: "spotify:playlist:37i9dQZF1E35nVVgp8iMex"
      - in: "Discover Weekly"
        out: "spotify:playlist:37i9dQZEVXcTh0pBxo9pZe"
      - in: "(DJ|deejay|dee jay)"
        out: "spotify:playlist:37i9dQZF1EYkqdzj48dyYq"
  

• spotifyplus_podcast_names Slot List

  This list is used primarily to identify Spotify Podcasts that either get misinterpreted when a spoken phrase is used, or if you want a specific podcast of multiple podcast renditions. For example, do you want "The Joe Rogan Experience", or "The Joe Rogan AI Experience"?

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly podcast identifiers.
  #
  # This list is used primarily to identify Spotify Podcasts that either get misinterpreted
  # when a spoken phrase is used, or if you want a specific podcast of multiple podcast
  # renditions.  For example, do you want "The Joe Rogan Experience", or "The Joe Rogan AI
  # Experience"?
  #
  #  in: Voice friendly identifier.
  # out: Spotify podcast uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_podcast_names:
    values:
      - in: "Armchair Expert"
        out: "spotify:show:6kAsbP8pxwaU2kPibKTuHE"
      - in: "Joe Rogan"
        out: "spotify:show:4rOoJ6Egrf8K2IrywzwOMk"
  

• spotifyplus_track_names Slot List

  This list is used primarily to identify Spotify Tracks that either get misinterpreted when a spoken phrase is used, or if you want a specific track of multiple track renditions. For example, do you want Journey's original 1981 version of the "Don't Stop Believin" track, or the 2022 remastered version?

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly track identifiers.
  #
  # This list is used primarily to identify Spotify Tracks that either get misinterpreted
  # when a spoken phrase is used, or if you want a specific track of multiple track
  # renditions.  For example, do you want Journey's original 1981 version of the 
  # "Don't Stop Believin" track, or the 2022 remastered version?
  #
  #  in: Voice friendly identifier.
  # out: Spotify track uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_track_names:
    values:
      - in: "Don't Stop Believing"
        out: "spotify:track:5ehcf6UL1TkwozB386cRAp" # Journey, 2024 Remaster
      - in: "Don't Stop Believing 1981"
        out: "spotify:track:3Ab9C0oz70wDyigunvnG5N" # Journey, 1981 Live, Escape Tour
  

The following sentence expansion rules are shared among all intent definitions.

• in_spotifyplus_player_area Expansion Rule

  (in|inn) [<the>] ({area}|{area} area|area {area})
  Refers to a specific media player assigned to an area name (e.g. "in the Office", "in the Office area", "in area Office", etc).

• on_spotifyplus_player_name Expansion Rule

  (on|for) [<the>] ({name} player|player {name})
  Refers to a specific media player by its friendly name or alias value (e.g. "on the Spotify Premium player", "on player Spotify Premium", etc).

• on_spotifyplus_device_name Expansion Rule

  (on|for) [<the>] ({device_name} device|device {device_name})
  Refers to a specific Spotify Connect device by its assigned remote name (e.g.
  e.g. "on the Office device", "on device Home Receiver", etc).

The SpotifyPlus sentence template files can be accessed via the web on the SpotifyPlus GitHub project.
The templates are also stored in the local copy of the repository downloaded by HACS:

<config>/custom_components/spotifyplus/sentences/<lang>

As of this writing, custom sentence templates for the integration only exist for the English (en) language. I expect that to change in the future though, and would love some help with language translations if you're willing.

To install the SpotifyPlus custom sentence templates, simply copy the files from the <config>/custom_components/spotifyplus/sentencess/<lang> location to the HA configuration directory <config>/custom_sentences/<lang> location, where <lang> is the 2 character language code of your choice (or en if your language code does not exist). You may need to create the custom_sentences directory, followed by the en (or your language code) sub-directory if they do not exist.

You can use the Developer Tools \ YAML configuration reloading \ Conversation button to reload the custom sentence templates (or just restart HA) if you decide to make changes to the sentence templates while testing. This causes your template changes to be picked up immediately.

More Information

• HA Sentence Template Syntax

I recommend setting up a separate template file for user-specific customizations for various lists used by the integration. This allows you to keep most of your customizations in one place, as well as prevent them from being accidentally overlaid if you update the custom sentence templates shipped with the integration.

The user template file should reside in the <config>/custom_sentences/<lang> location, where <lang> is the 2 character language code of your choice (or en if your language code does not exist).

The user template file name should have a prefix of spotifyplus_ and a file extension of .yaml. For example, a file name of spotifyplus_common_user_settings_en.yaml would be perfect.

The user tmeplate file will contain settings specific to your preferences.

# ============================================================================
# SpotifyPlus integration intent common user list data.
#
# Location: custom_sentences/en/spotifyplus_common_user_lists_en.yaml
# Language: en, English
# ============================================================================
language: en
lists:

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly album identifiers.
  #
  # This list is used primarily to identify Spotify Albums that either get misinterpreted
  # when a spoken phrase is used, or if you want a specific album of multiple album
  # renditions.  For example, do you want Journey's original 1981 version of the 
  # "Escape" album tour, or the 2022 remastered version?
  #
  #  in: Voice friendly identifier.
  # out: Spotify album uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_album_names:
    values:
      - in: "Escape"
        out: "spotify:album:4guAwaniEAEQSW0NCpo4gm" # Journey, 2022 Remaster
      - in: "Escape 1981"
        out: "spotify:album:0gHmMKZ9s3ztqeMfAzwxRL" # Journey, 1981 Live, Escape Tour
      - in: "Test Album List Entry"
        out: "spotify:album:4guAwaniEAEQSW0NCpo4gm" # Journey, Escape, 2022 Remaster

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly audiobook identifiers.
  #
  # This list is used primarily to identify Spotify Audiobooks that either get misinterpreted
  # when a spoken phrase is used, or if you want a specific audiobook of multiple audiobook
  # renditions.
  #
  #  in: Voice friendly identifier.
  # out: Spotify audiobook uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_audiobook_names:
    values:
      - in: "Test Book List Entry"
        out: "spotify:show:74aydHJKgYz3AIq3jjBSv1" # The Elfstones of Shannara

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly device name identifiers.
  #
  # This list is used to identify Spotify Connect device names.
  # These should align with what's in the `source_list` attribute of the media player.
  #
  #  in: Voice friendly identifier.
  # out: SpotifyPlus media_player source_list entry.
  # --------------------------------------------------------------------------------------
  spotifyplus_device_names:
    values:
      - in: "(Bose-ST10-1|Bose 1)"
        out: "Bose-ST10-1"
      - in: "(Bose-ST10-2|Bose 2)"
        out: "Bose-ST10-2"
      - in: "(Bose-ST10-3|Bose 3)"
        out: "Bose-ST10-3"
      - in: "(Bose-ST10-4|Bose 4)"
        out: "Bose-ST10-4"
      - in: "(Bose-ST300|Bose 300)"
        out: "Bose-ST300"
      - in: "(Google Home 1|Google Home One|Home 1|Home One)"
        out: "Google Home 01"
      - in: "(Nest Audio 1|Nest Audio One|Nest 1|Nest One)"
        out: "Nest Audio 01"
      - in: "(Sonos 01|Sonos 1|Sonos One)"
        out: "Sonos 01"

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly playlist identifiers.
  #
  # This list is used primarily to identify Spotify Algorithmic Playlists, which
  # cannot be returned by the Spotify Web API as of 2024/11/27.
  # More info: https://developer.spotify.com/blog/2024-11-27-changes-to-the-web-api
  #
  #  in: Voice friendly identifier.
  # out: Spotify playlist uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_playlist_names:
    values:
      - in: "Daily Mix (1|One)"
        out: "spotify:playlist:37i9dQZF1E39vTG3GurFPW"
      - in: "Daily Mix (2|Two)"
        out: "spotify:playlist:37i9dQZF1E39DIjrju3A9t"
      - in: "Daily Mix (3|Three)"
        out: "spotify:playlist:37i9dQZF1E36yv9pXdC1Mb"
      - in: "Daily Mix (4|Four)"
        out: "spotify:playlist:37i9dQZF1E35Ejqg6yJW0p"
      - in: "Daily Mix (5|Five)"
        out: "spotify:playlist:37i9dQZF1E35nVVgp8iMex"
      - in: "Discover Weekly"
        out: "spotify:playlist:37i9dQZEVXcTh0pBxo9pZe"
      - in: "(DJ|deejay|dee jay)"
        out: "spotify:playlist:37i9dQZF1EYkqdzj48dyYq"
      - in: "Test Playlist List Entry"
        out: "spotify:playlist:37i9dQZF1E39vTG3GurFPW"  # Daily Mix 1

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly podcast identifiers.
  #
  # This list is used primarily to identify Spotify Podcasts that either get misinterpreted
  # when a spoken phrase is used, or if you want a specific podcast of multiple podcast
  # renditions.  For example, do you want "The Joe Rogan Experience", or "The Joe Rogan AI
  # Experience"?
  #
  #  in: Voice friendly identifier.
  # out: Spotify podcast uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_podcast_names:
    values:
      - in: "Armchair Expert"
        out: "spotify:show:6kAsbP8pxwaU2kPibKTuHE"
      - in: "Test Podcast List Entry"
        out: "spotify:show:6kAsbP8pxwaU2kPibKTuHE"  # Armchair Expert with Dax Sheppard

  # --------------------------------------------------------------------------------------
  # SpotifyPlus voice-friendly track identifiers.
  #
  # This list is used primarily to identify Spotify Tracks that either get misinterpreted
  # when a spoken phrase is used, or if you want a specific track of multiple track
  # renditions.  For example, do you want Journey's original 1981 version of the 
  # "Don't Stop Believin" track, or the 2022 remastered version?
  #
  #  in: Voice friendly identifier.
  # out: Spotify track uri value.
  # --------------------------------------------------------------------------------------
  spotifyplus_track_names:
    values:
      - in: "Don't Stop Believing"
        out: "spotify:track:5ehcf6UL1TkwozB386cRAp" # Journey, 2024 Remaster
      - in: "Don't Stop Believing 1981"
        out: "spotify:track:3Ab9C0oz70wDyigunvnG5N" # Journey, 1981 Live, Escape Tour
      - in: "Test Track List Entry"
        out: "spotify:track:6zd8T1PBe9JFHmuVnurdRp" # Seventh Day Slumber, I Need You

Entities must first be exposed in order to control them with Home Assistant Voice Assist.

To do that, go to your HA Settings \ Voice Assistants \ Expose panel (see Figure 1). This panel allows you to add / remove what entities are exposed, and define aliases, assign areas, etc.

Figure 1 - Home Assistant Voice Expose Settings

If you are just getting started with HA voice, have a look at the HA Exposing Entities to Assist documentation to get started.