Skip to main content
Server path: /spotify-player | Type: Application | PCID required: Yes

Tools


spotify_player_add_to_queue

Add Item to Playback Queue Parameters:
ParameterTypeRequiredDefaultDescription
uristringYesThe uri of the item to add to the queue. Must be a track or an episode uri.
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

spotify_player_get_a_users_available_devices

Get Available Devices

spotify_player_get_information_about_the_users_current_playback

Get Playback State Parameters:
ParameterTypeRequiredDefaultDescription
marketstringNoAn ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.<br/> If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.<br/> Note: If neither market or user country are provided, the content is considered unavailable for the client.<br/> Users can view the country that is associated with their account in the account settings.
additional_typesstringNoA comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.<br/> Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future.<br/> In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

spotify_player_get_queue

Get the User’s Queue

spotify_player_get_recently_played

Get Recently Played Tracks Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
afterintegerNoA Unix timestamp in milliseconds. Returns all items after (but not including) this cursor position. If after is specified, before must not be specified.
beforeintegerNoA Unix timestamp in milliseconds. Returns all items before (but not including) this cursor position. If before is specified, after must not be specified.

spotify_player_get_the_users_currently_playing_track

Get Currently Playing Track Parameters:
ParameterTypeRequiredDefaultDescription
marketstringNoAn ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.<br/> If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.<br/> Note: If neither market or user country are provided, the content is considered unavailable for the client.<br/> Users can view the country that is associated with their account in the account settings.
additional_typesstringNoA comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.<br/> Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future.<br/> In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

spotify_player_pause_a_users_playback

Pause Playback Parameters:
ParameterTypeRequiredDefaultDescription
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

spotify_player_seek_to_position_in_currently_playing_track

Seek To Position Parameters:
ParameterTypeRequiredDefaultDescription
position_msintegerYesThe position in milliseconds to seek to. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

spotify_player_set_repeat_mode_on_users_playback

Set Repeat Mode Parameters:
ParameterTypeRequiredDefaultDescription
statestringYestrack, context or off.<br/> track will repeat the current track.<br/> context will repeat the current context.<br/> off will turn repeat off.
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

spotify_player_set_volume_for_users_playback

Set Playback Volume Parameters:
ParameterTypeRequiredDefaultDescription
volume_percentintegerYesThe volume to set. Must be a value from 0 to 100 inclusive.
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

spotify_player_skip_users_playback_to_next_track

Skip To Next Parameters:
ParameterTypeRequiredDefaultDescription
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

spotify_player_skip_users_playback_to_previous_track

Skip To Previous Parameters:
ParameterTypeRequiredDefaultDescription
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

spotify_player_start_a_users_playback

Start/Resume Playback Parameters:
ParameterTypeRequiredDefaultDescription
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.
context_uristringNoOptional. Spotify URI of the context to play. Valid contexts are albums, artists & playlists. &#123;context_uri:"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"&#125;
offsetobjectNoOptional. Indicates from where in the context playback should start. Only available when context_uri corresponds to an album or playlist object “position” is zero based and can’t be negative. Example: "offset": &#123;"position": 5&#125; “uri” is a string representing the uri of the item to start at. Example: "offset": &#123;"uri": "spotify:track:1301WleyT98MSxVHPZCA6M"&#125;
position_msintegerNointeger
urisstring[]NoOptional. A JSON array of the Spotify track URIs to play. For example: &#123;"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]&#125;

spotify_player_toggle_shuffle_for_users_playback

Toggle Playback Shuffle Parameters:
ParameterTypeRequiredDefaultDescription
statebooleanYestrue : Shuffle user’s playback.<br/> false : Do not shuffle user’s playback.
device_idstringNoThe id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

spotify_player_transfer_a_users_playback

Transfer Playback Parameters:
ParameterTypeRequiredDefaultDescription
device_idsstring[]YesA JSON array containing the ID of the device on which playback should be started/transferred.<br/>For example:&#123;device_ids:["74ASZWbe4lXaubB36ztrGX"]&#125;<br/>Note: Although an array is accepted, only a single device_id is currently supported. Supplying more than one will return 400 Bad Request
playbooleanNotrue: ensure playback happens on new device.<br/>false or not provided: keep the current playback state.