Developer Console
Thank you for your visit. This page is only available in English at this time.

GetDisplayableItems Directives (VSK Echo Show)

When users make utterances to find content or try to access the content provider landing page, the VideoContentProvider API sends a GetDisplayableItems directive to your Lambda.

The following diagram shows the expected Alexa directive and Lambda response;

GetDisplayableItems Directive and Lambda GetDisplayableItemsResponse

Utterances for GetDisplayableItems

Alexa sends a GetDisplayableItems directive to your Lambda when users say the following utterances.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

Search for breaking bad

A list of matches for the title is presented to the user.

Search by actor
Required for certification

Search for sean connery

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

Search for comedy

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

Search for star trek

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

Search movies

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

Search breaking bad season two

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

Search for breaking bad episode five

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

Search for breaking bad season two episode five

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

Search for james bond

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

Search for quentin tarantino

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

Search for disney

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

Search seahawks

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

Search for soccer

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

Search for n. b. a. league

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

Search for soccer game

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

Launch netflix app

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

Launch a. t. and t. u-verse app

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

trouve / cherche / montre [VideoName] sur [AppName]

A list of matches for the title is presented to the user.

Search by actor
Required for certification

recherche des films avec [ActorName]

cherche des films avec [ActorName]

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

recherche un/une [GenreName]

cherche un/une [GenreName]

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

recherche [VideoName]

cherche [VideoName]

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

recherche [mediatype]

cherche [mediatype]

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

recherche la saison [number] de [title]

cherche la saison [number] de [title]

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

recherche la saison [number] de [title]

cherche la saison [number] de [title]

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

recherche/cherche la saison [SeasonNumber] de [VideoName]

recherche/cherchel'épisode [EpisodeNumber] de [VideoName]

recherche/cherchel'épisode [EpisodeNumber] de la saison [SeasonNumber] de [VideoName]

recherche/cherchela saison [SeasonNumber] de [VideoName]

recherche/cherchel'épisode [EpisodeNumber] de [VideoName]

recherche/cherchel'épisode [EpisodeNumber] de la saison [SeasonNumber] de [VideoName]

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

recherche un film avec [charactername]

cherche un film avec [charactername]

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

recherche un film de [DirectorName]

cherche un film de [DirectorName]

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

recherche des films de disney

cherche des films de disney

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

Not supported

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

Not supported

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

recherche [league]

cherche [league]

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

Not supported

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

pars [AppName]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

pars [AppName]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

trouve / cherche / montre [VideoName] sur [AppName]

A list of matches for the title is presented to the user.

Search by actor
Required for certification

cherche des films avec [ActorName]

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

cherche une comédie

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

cherche star trek

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

Cherche [mediatype]

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

cherche la saison [number] de [title]

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

cherche l'épisode [number] de [title]

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

cherche la saison [SeasonNumber] de [VideoName]

cherche l'épisode [EpisodeNumber] de [VideoName]

cherche l'épisode [EpisodeNumber] de la saison [SeasonNumber] de [VideoName]

cherche la saison [SeasonNumber] de [VideoName]

cherche l'épisode [EpisodeNumber] de [VideoName]

cherche l'épisode [EpisodeNumber] de la saison [SeasonNumber] de [VideoName]

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

cherche un film avec [charactername]

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

cherche un film de quentin tarantino

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

cherche des films de disney

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

Not supported

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

Not supported

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

cherche [league]

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

Not supported

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

lance [AppName]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

lance [AppName]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

such nach? [VideoName] such/zeig/find film? [VideoName] auf [AppName]

zeig mir film? [VideoName] auf [DeviceBrand]

such trailer von [VideoName]

A list of matches for the title is presented to the user.

Search by actor
Required for certification

such [ActorNameName] filme

zeig filme mit [ActorNameName]

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

zeig [GenreNameName] filme auf [AppName]

such nach [GenreName] [MediaType]

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

such nach? [VideoName] such/zeig/find film? [VideoName] auf [AppName]

zeig mir film? [VideoName] auf [DeviceBrand]

such trailer von [VideoName]

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

find [MediaType]

such/zeig/empfiehl [MediaType]

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

spiel [VideoName] [Season] [Season_Numer]

spiel [VideoName]

[Season] [Season_Numer] auf [AppName]

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

spiel die [Episode_Number] [Episode] von [VideoName]

spiel [VideoName] [Episode_Number]

spiel von [VideoName] [Episode] [Episode_Number]

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

spiel [Season] [Season_Numer] [Episode] [Episode_Number] von [VideoName]

spiel [VideoName] [Season] [Season_Numer] [Episode] [Episode_Number]

spiel die [VideoName] [Season] [Season_Numer] [Episode]

[Episode_Number] auf [AppName] ab

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

Not supported

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

such nach [MediaType] mit [ActorName]

such [ActorName] [MediaType]

zeig [MediaType] mit [ActorName]

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

suche nach [ProductionCompany] filmenzeige mir [ProductionCompany] filme

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

such [Sport] [Event]

find [Sport] [Event]

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

Not supported

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

such [Sport] [Event]

find [Sport] [Event]

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

starte [AppName]

spiel/öffne [AppName] app

starte [AppName] auf [DeviceBrand]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

starte [AppName]

spiel/öffne [AppName] app

starte AppName auf [DeviceBrand]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

[VideoName] खोजो/ढूँढो [AppName] पे/पर/में [VideoName] दिखा/खोज दो मुझे [VideoName] दिखाओ/खोजो/ढूँढो मुझे [AppName] पे/पर/में [VideoName] दिखाओ/खोजो/ढूँढो मुझे [VideoName] को [AppName] पे

पर में दिखाओ/खोजो/ढूँढो खोजो [VideoName]

A list of matches for the title is presented to the user.

Search by actor
Required for certification

[ActorName] के/का/की/वाला movies दिखाओ/ढूँढो

[ActorName] के/का/की/वाला [GenreName] movies दिखाओ/खोजो/ढूँढो

[ActorName] के/का/की/वाला [GenreName] movie [VideoName] दिखाओ/खोजो/ढूँढो

दिखाओ/खोजो [ActorName] के/का/की/वाला [GenreName] movies

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

[GenreName] movies दिखाओ/ढूँढो

[ActorName] के/का/की/वाला [GenreName] movies दिखाओ/खोजो/ढूँढो

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

start trek के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

[VideoName] movie दिखाओ/ढूँढो

[AppName] पे/पर/में [MediaType] को खोजो

[ChannelName] को खोजो/ढूँढो

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

breaking bad season दो ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

breaking bad episode पाँच के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

breaking bad season दो episode five के लिये ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

[CharacterName] movie दिखाओ/खोजो [CharacterName] के/का/की/वाला movie [VideoName] दिखाओ/खोजो/ढूँढो

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

quentin tarantino के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

disney के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

[Sport/League/Seam] games दिखाओ/खोजो/ढूँढो

[Sport] के [Event] को दिखाओ/खोजो [Sport] के [Event] को दिखाओ/खोजो

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

[Sport/League/Seam] games दिखाओ/खोजो/ढूँढो

[Sport] के [Event] को दिखाओ/खोजो

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

[Sport/League/Seam] games दिखाओ/खोजो/ढूँढो

[Sport] के [Event] को दिखाओ/खोजो

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

[Sport/League/Seam] games दिखाओ/खोजो/ढूँढो

[Sport] के [Event] को दिखाओ/खोजो

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

netflix launch करो/करना/कीजिए/करिएगा

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

facebook app launch करो/करना/कीजिए/करिएगा

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

trova / cerca / mostra / dammi + VideoName (+ da/su ServiceName)?

A list of matches for the title is presented to the user.

Search by actor
Required for certification

cerca film con [ActorName]

trova un film con [ActorName]

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

cerca [GenreName]

trova [GenreName]

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

cerca [VideoName]

trova [VideoName]

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

cerca [mediatype]

trova mi un [mediatye]

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

cerca la stagione due di [VideoName]

trova la stagione due di [VideoName]

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

cerca [VideoName] Episodio cinque

trova [VideoName] Episodio cinque

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

cerca [VideoName] episodio [EpisodeNumber]

trova [VideoName] episodio [EpisodeNumber]

cerca [VideoName] stagione [SeasonNumber]

trova [VideoName] stagione [SeasonNumber]

cerca [VideoName] stagione [SeasonNumber] episodio [EpisodeNumber]

trova [VideoName] stagione [SeasonNumber] episodio [EpisodeNumber]

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

cerca un film con [CharacterName]

trova un film con [CharacterName]

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

cerca [DirectorName]

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

cerca disney

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

not supported

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

cerca [Sport]

trova [Sport]

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

not supported

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

cerca partite di [SportName]

trova partite di calcio

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

lancia [AppName]

apri [AppName]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

apri [special character AppName]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

[VideoName]を探して[VideoName]を<AppName]で探して

A list of matches for the title is presented to the user.

Search by actor
Required for certification

[ActorNameName]が出ている[MediaType]を探して

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

[GenreNameName]の[MediaType]を見つけて

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

[MediaType]を探して

[AppName]で[MediaType]を探して

[ChannelName]を検索

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

[title] シーズン[SeasonNumber] エピソード[EpisodeNumber] を探して

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

[CharacterNameName]が主人公の[MediaType]を探して

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

[ProductionCompany]を検索

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

[Sport]の[Event]を見つけて[SportTeam]の[Event]を見つけて

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

[Sport]の[Event]を見つけて[SportTeam]の[Event]を見つけて

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

[Sport]の[Event]を見つけて[SportTeam]の[Event]を見つけて

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

[Sport]の[Event]を見つけて[SportTeam]の[Event]を見つけて

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

procurar/buscar/mostrar [VideoName] no/na [AppName]

 

A list of matches for the title is presented to the user.

Search by actor
Required for certification

procurar por [ActorName]

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

procurar por [GenreName]

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

procurar[VideoName]

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

procurar [MediaType]

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

procurar [VideoName] temporada [SeasonNumber]

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

procurar por [title] episódio [EpisodeNumber]

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

procurar por [VideoName]episódio [EpisodeNumber]procurar por

[VideoName]temporada [SeasonNumber]procurar por [VideoNumber]temporada

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

not supported

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

not supported

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

Procurar/procura/procure por [ProductionCompany]

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

procurar por[SportTeam]

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

procurar por [Sport]

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

procurar por [League]

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

procurar por [SportName]

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

abrir [AppName]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

abrir [special character AppName]

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Feature Sample Utterances Expected Response
Search for [title]
Required for certification

muestra juego de tronos

enséña me el efecto mariposa

A list of matches for the title is presented to the user.

Search by actor
Required for certification

busca películas con antonio banderas

A list of matches featuring the actor is presented to the user.

Search by genre name
Required for certification

busca comedias románticas

The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user).

Search by franchise [title]
Required for certification

busca shrek

The user is presented with a list of matching results for the franchise.

Search by media type
Optional

busca películas

enséña me las películas

busca películas en netflix

A list of matches for the desired media type is presented to the user.

Search [title] with season number
Optional

enséña me la segunda temporada de friends

All episodes for the matching season are presented to the user.

Search [title] with episode number
Optional

busca el capítulo final de los serrano*

A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears.

Search [title] with season and episode number
Optional

busca el segundo episodio de la primera temporada de anabel*

A list of available episodes for the season the user requested appears, including the episode the user specifically asked for.

Search by character name
Optional

busca películas de la pantera negra

The user is presented with a list of matching results for media featuring the character name.

Search by director name
Optional

busca las películas de alejandro lozano

The user is presented with a list of matching results for media produced by the requested director.

Search by production company
Optional

busca películas de disney

The user is presented with a list of matching results for media from the production company.

Search by sports team
Optional

busca el partido del real madrid

The user is presented with a list of matching results for the sports team.

Search by sports type
Optional

enséña nos un vídeo de fútbol

The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user).

Search by sports league
Optional

busca el partido de la

n. b. a.

The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user).

Search by sports event
Optional

busca el partido de fútbol

The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user).

Launch [partner] app
Required for certification

lanza la app de netflix

lanza netflix

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Launch special character title
Required for certification

lanza i. b. e. x. treinta y cinco

The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories.

Handling GetDisplayableItems Directives

When users search for content using criteria like VideoName, ActorName, GenreName, etc., Alexa sends a GetDisplayableItems directive to retrieve content to display.

Your Lambda response (GetDisplayableItemsResponse) should contain basic identifying information about the content that matches the user’s search request. Your response should not contain additional metadata such as images, etc.

Note that Alexa supports non-title requests such as "Alexa, find a comedy on <video provider>" or "Alexa, find football on <video provider>." For these requests, the expectation is that you conduct a search within your catalog and return a list of titles that matches the search request. Leverage any personalization algorithms you may have to bias the result to the user.

If you cannot find any results matching the user's request and return zero results in your response, you receive a second GetDisplayableItems directive with the SortType = Recommended. You can then return a set of recommended videos to the user in your response. Alexa tells the user that there are no search results, but that Alexa recommends this content to the user.

{
   "type": "SORTTYPE",
   "value": "RECOMMENDED"
}

GetDisplayableItems Example

The following is an example of a GetDisplayableItems directive:

{
    "directive": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
            "messageId": "9f4803ec-4c94-4fdf-89c2-d502d5e52bb4",
            "name": "GetDisplayableItems",
            "namespace": "Alexa.VideoContentProvider",
            "payloadVersion": "3"
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "access-token-from-skill"
            },
            "endpointId": "videoDevice-001",
            "cookie": {

            }
        },
        "payload": {
            "entities": [
                {
                    "type": "Video",
                    "value": "Manchester by the Sea",
                    "externalIds": {
                        "gracenote": "MV000000099001"
                    }
                }
            ],
            "contentType": "RECORDING",
            "locale": "en-US",
            "minResultLimit": 8,
            "maxResultLimit": 25,
            "timeWindow": {
                "end": "2016-09-07T23:59:00+00:00",
                "start": "2016-09-01T00:00:00+00:00"
            }
        }
    }
}

GetDisplayableItems Example (Landing Page)

When a user opens the provider landing page, Alexa sends two GetDisplayableItems directives.

  • The first directive is to retrieve categories for the landing page by setting the itemType property to CATEGORY and including a sortType of RECOMMENDED.
  • The second directive obtains the featured video for the landing page where the directive sets the itemType to VIDEO instead.

After that, Alexa sends one GetDisplayableItemsMetadata call with a list combined of Category IDs and Video ID. The response includes metadata about the video as well as the categories.

The following shows an example of a GetDisplayableItems directive used for a landing page:

{
   "directive": {
       "header": {
           "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
           "messageId": "9f4803ec-4c94-4fdf-89c2-d502d5e52bb4",
           "name": "GetDisplayableItems",
           "namespace": "Alexa.VideoContentProvider",
           "payloadVersion": "3"
        },
       "endpoint": {
           "scope": {
               "type": "BearerToken",
               "token": "access-token-from-skill"
            },
           "endpointId": "videoDevice-001",
           "cookie": {

            }
        },
       "payload": {
           "entities": [
                {
                   "type": "SORTTYPE",
                   "value": "RECOMMENDED"
                }
            ],
           "itemType" : "VIDEO",
           "locale": "en-US",
           "minResultLimit": 1,
           "maxResultLimit": 1
        }
    }
}

itemType specifies the type of item to be searched. The values can be either VIDEO or CATEGORY.

Payload Descriptions

The following table defines the payload fields for GetDisplayableItems directives.

Payload Descriptions
Field Description Data Type
entities
required

A list of entity objects to search. The relationship between different entity types should usually be interpreted as an AND operation. For example, if the request contains {genreName = "Comedy," actorName ="Tom Hanks"}, it implies that the search result should contain Comedy movies/TV shows with Tom Hanks.

However, if the request contains multiple entities of the same type, such as {videoName = "Interstellar," VideoName = "Interstellar Wars"}, then you can consider this as an OR operation and can search for all the entities in the directive. If in doubt, assume that the top entity within the type (videoName in this case) is the most relevant.

Let's say you have another request with {mediaType = "MOVIE', genreName = "Comedy," actorName ="Tom Hanks," actorName = "Tom Hanks}. This is assuming that there are multiple actors named Tom Hanks. In such cases, you can search for movies with all the actors in the request and then filter based on the Comedy genre to return all the search results.

Alexa does not rank the entities today because Alexa does not have a way to know what the user wants to play when there are multiple matching entities.

entities with a type: Channel contain identifying data for a television channel. For example:

 {
  "type": "Channel",
  "value": "PBS",
  "externalIds": {
      "gracenote": "MV000000099001"
  },
  "entityMetadata": {
      "channelCallSign": "KBTC",
      "channelNumber": "123"
  }
} 

List
type
required

Entity types for video content. For a list of video content entity types, see Entity Types for Video Content. Note that multimodal devices have the following additional entity types: LISTTYPE, SORTTYPE.

LISTTYPE is populated when users wants to browse their Watchlist or Library. For example, utterances like "Show me my Watchlist" or "Show me my Video Library." LISTTYPE can have the following enum values:

  • WATCHLIST: For "Show me my Watchlist" — used to show videos the user has added to their watchlist.
  • LIBRARY: For "Show me my Video Library" — used to show videos that are in the users' library. Typically, these are the videos that have been purchased by the user.

SORTTYPE is used to give additional information about the request that should be used during the searches and how results need to be sorted. For example, for "Show me recommended movies," Alexa needs recommendations from the content provider. SORTTYPE can have the following enum value:

  • RECOMMENDED: This value is populated for utterances like "Show me recommended movies," or "Show me recommended action movies," etc.

Examples: MediaType, video, Actor, Genre, Franchise, Season, Episode

String
value
required

The value of the entity. For channels, the name of the channel.

Examples: Interstellar, PBS

String
itemType
required

itemType specifies the type of item to be searched. itemType is unique for GetDisplayableItems directives related to the landing page template. When a user opens your landing page (by saying "Alexa, open ACME video" or by saying "Video Home" and then selecting your video skill), Alexa sends two GetDisplayableItems directives:

  • The first GetDisplayableItems directive is to retrieve categories for the landing page by setting the itemType property to CATEGORY and including a sortType of RECOMMENDED.
  • The second GetDisplayableItems directive obtains the featured video for the landing page where the request sets the itemType to VIDEO instead.

After receiving your response (GetDisplayableItemsResponse) for both directives, Alexa sends one GetDisplayableItemsMetadata call with a list combined of Category IDs and Video ID. The response includes metadata about the video as well as the categories.

Example: VIDEO, CATEGORY

Enum
externalIds
optional
A map of external identifiers for this entity; key is the provider, value is the id. / Identifiers for this Entity, unique within the scope of this endpoint

Examples: key = gti, value = SH000000012

Object
Gracenote
optional

The external Gracenote identifier.

Example: SP0000000666661

String
contentType
required

ContentType specifies the content type for the video that was returned in the search results. If you send a recorded movie or TV show, the contentType is set to RECORDING. If the result contains information about a live TV show, then the contentType is set to LIVE. If the result contains an on-demand content, then the contentType is set to ON_DEMAND.

ContentType is also used to render a prompt to the user. For example, if the contentType is LIVE, Alexa renders a prompt such as, "Here's the Academy Awards now airing on CBS." If the contentType is RECORDING, Alexa renders a prompt such as, "Here's the Academy Awards."

Examples: RECORDING, LIVE, ON_DEMAND

Enum
locale
required

The locale for the user that should be used to get displayable information for the search results. A locale in the same format specified for languages in in the Network Working Group Best Current Practice 47 (BCP-47). If you receive an unrecognized locale, default to en-US.

Examples: en-US, en-GB, de-DE

String
minResultLimit
required

The minimum number of results to return in this call for which a pageToken is accepted. If you return less than the minResultLimit field along with a pageToken to fetch more results, then Alexa does not consider the pageToken to fetch the new items and only displays whatever Alexa received.

For a pageToken to be considered for fetching more results, the number of items have to match at least the value in minResultLimit. However, the number of items can be more than minResultLimit up to a max of maxResultLimit. If the number of items is more than the maxResultLimit, Alexa discards the items after the maxResultLimit.

Example: 8

Integer
maxResultLimit
required

A limit to the maximum number of results to return. See description of minResultLimit field for more details.

Example: 25

Integer
timeWindow
optional

Provides the start and end times that the request should act on. This is usually used for Live TV or Recording only and not for On Demand content. Generally, if the time window is available and can be used to filter the results, you should use it.

For providers that only search for On Demand content, the time window field is usually be set to null and can be ignored.

For Live TV or Recording, if the user specifies the time window, for example, "Search for TV shows between 4 and 5 pm," or "Find TV shows recorded last week," then you should filter the results based on the start and end times whenever available.

Depending on the capabilities, either both the fields — start and end — can be present, or any one field can be present. For example for "Search TV shows between 4 and 5 pm," both the fields are present. For "Show me TV shows starting at 5 pm," only the start field is populated while end is null.

Object containing start and end times.
end
optional

The end time of the time window.

Examples: 2016-09-07T23:59:00+00:00, 2018-01-24T02:30:00Z

A string in ISO 8601 format.
start
optional

The start time of the time window.

Examples: 2016-09-07T23:59:00+00:00, 2018-01-24T02:30:00Z

A string in ISO 8601 format.

Entity Types

The entities object consists of a list of objects, each of which contains a type and a value along with other possible data such as external IDs. The following values are possible for the type value: Actor, App, Channel, Character, Director, Episode, Event, Franchise, Genre, League, MediaType, ProductionCompany, Season, Sport, SportsTeam, Video, Popularity, Recency, and VideoResolution. Details about the payloads for each entity type are provided in the sections below.

Actor

Actor represents an actor credited in video media content; for example, Casey Affleck might contain the following:

App

App represents the explicit app name specified by the user in utterance; for example, "Manchester by the Sea on Prime" might contain the following:

Channel

Channel represents the identifying data for a television channel; for example, "PBS" might contain the following:

Character

A character represented in video media content; for example, Snow White might contain the following:

Director

Director represents the director name for the video media content; for example, "Kenneth Lonergan" might contain the following.

Episode

Episode represents the episode number for serial content like TV Shows; for example, the eighth episode of "Transparent" would have episode number 8.

Event

An event is a reference to a type of event; examples would include sports, music, or other types of events. For example, searching for "Football games" would search for a game event entity and a football sport entity.

Franchise

A franchise is a video entity which can represent a number of video entities, like movies or TV shows. For example, take the fictional franchise "Intergalactic Wars" which represents a collection of movie trilogies, as well as animated and live action TV shows. This entity type was introduced to account for requests by customers such as "Find Intergalactic Wars movies", which would search for all "Intergalactic Wars" programs of the MOVIE value for MediaType, rather than attempting to match to a single title.

Genre

Genre represents the genre of video media content such as action, drama or comedy. For example, the Action genre might contain the following:

League

League represents the categorical information for a sporting league; for example, NCAA is a league that might contain the following:

MediaType

MediaType represents the media type category of a particular piece of content; for example, the MediaType for "Manchester by the Sea" would be MOVIE.

ProductionCompany

ProductionCompany represents the production company name for the video media content; for example, Marvels, Disney.

Season

Season represents the season number for serial content like TV Shows; for example, the season two of "Transparent" would have season number 2.

Sport

Sport represents the categorical information of a sport; for example, football is a sport that might contain the following:

SportsTeam

SportsTeam represents the categorical information of a professional sports team; for example, "University of Washington Huskies" is a sports team that might contain the following:

Video

Video represents the identifying data for the piece of video content; for example, "Manchester by the Sea" might contain the following:

Popularity

Popularity indicates whether the user asks for popular content.

Recency

The resolved values for Recency indicate whether the user asks for new or old content.

VideoResolution

VideoResolution represents the requested video resolution in one of the following standards:

  • SD (480p)
  • HD (720p-1080p)
  • 4k (2160p)
  • 8k (4320p)

Response Example

After receiving a GetDisplayableItems directive, your Lambda should send a GetDisplayableItemsResponse. The response should contain list of id values of the items to display on the device.

The following is an example of a GetDisplayableItemsResponse that your Lambda should send back to Alexa.

{
"directive": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
            "messageId": "5f0a0546-caad-416f-a617-80cf083a05cd",
            "name": "GetDisplayableItemsResponse",
            "namespace": "Alexa.VideoContentProvider",
            "payloadVersion": "3"
        },
        "payload": {
            "nextToken": "fvkjbr20dvjbkwOpqStr",
            "mediaItems": [{
                    "mediaIdentifier": {
                        "id": "tt1254207"
                    }
                },
                {
                    "mediaIdentifier": {
                        "id": "tt0807840"
                    }
                },
                {
                    "mediaIdentifier": {
                        "id": "tt7993892"
                    }
                },
                {
                    "mediaIdentifier": {
                        "id": "tt4957236"
                    }
                },
                {
                    "mediaIdentifier": {
                        "id": "tt2285752"
                    }
                }
            ]
        }
    }
};

Payload Descriptions

The following table describes the payload fields in your GetDisplayableItemsResponse.

Payload Descriptions
Field Description Data Type
nextToken
optional

Token to fetch the next set of results. An opaque string sent by the provider which is passed back in subsequent search requests.

String
mediaItems
required

A list of mediaIdentifiers for the videos that are shown as search results on the screen.

List
mediaIdentifier
required

Identifier for the mediaItem. See Retrieve Image Size Data from the mediaIdentifier Object.

Object
id
required

An identifier for the video item that is used to fetch any display or playback related metadata information on subsequent calls to GetDisplayableItemsMetadata or GetPlayableItemsMetadata. This identifier is opaque to Alexa and is just used as-is when querying for metadata information.

String

Declaring Capability Support for this Interface

To indicate that your video skill supports the Alexa.RemoteVideoPlayer interface, you must indicate support for it in your response to the Discover directive sent through the Alexa.Discovery interface. More details are provided in Alexa.Discovery.


Last updated: Oct 30, 2020