Audiobooks
Get an Audiobook
Get Several Audiobooks
Get Audiobook Chapters
ModelsExpand Collapse
class SimplifiedChapterObject:
id: String
The Spotify ID for the chapter.
DeprecatedaudioPreviewUrl: Optional<String>
A URL to a 30 second preview (MP3 format) of the chapter. null if not available.
chapterNumber: Long
The number of the chapter
description: String
A description of the chapter. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
durationMs: Long
The chapter length in milliseconds.
explicit: Boolean
Whether or not the chapter has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this chapter.
published: Optional<Boolean>
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify: Optional<String>
The Spotify URL for the object.
href: String
A link to the Web API endpoint providing full details of the chapter.
htmlDescription: String
A description of the chapter. This field may contain HTML tags.
The cover art for the chapter in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<Boolean>
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
isPlayable: Boolean
True if the chapter is playable in the given market. Otherwise false.
languages: List<String>
A list of the languages used in the chapter, identified by their ISO 639-1 code.
name: String
The name of the chapter.
releaseDate: String
The date the chapter was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".
releaseDatePrecision: ReleaseDatePrecision
The precision with which release_date value is known.
type: JsonValue; "episode"constant"episode"constant
The object type.
uri: String
The Spotify URI for the chapter.
availableMarkets: Optional<List<String>>
A list of the countries in which the chapter can be played, identified by their ISO 3166-1 alpha-2 code.
published: Optional<Boolean>
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published: Optional<Boolean>
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason: Optional<String>
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.payment_required- Payment is required to play the content item.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
The user's most recent position in the chapter. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
fullyPlayed: Optional<Boolean>
Whether or not the episode has been fully played by the user.
published: Optional<Boolean>
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
resumePositionMs: Optional<Long>
The user's most recent position in the episode in milliseconds.