GetNextPage Directives (VSK Echo Show)
When users select to go to the "next page" of search results, or when they scroll beyond the viewable search results on the screen, the VideoContentProvider API sends a GetNextPage
directive to your Lambda to fetch more results. Your response provides additional items to populate the next page.
The following diagram shows this workflow:
- Utterances for GetNextPage Directives
- Handling GetNextPage Directives
- GetNextPage Example
- Payload Descriptions
- Lambda Response
- Response Example
- Payload Descriptions
Utterances for GetNextPage Directives
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
Next |
The next page of results appears on the screen. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
prochain(e) suivant(e) next |
The next page of results appears on the screen. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
prochain(e) suivant(e) next |
The next page of results appears on the screen. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
nächste nächstes das nächste spring/geh vor spring/geh vorwärts vor überspring das eins weiter/vorwärts weiter spring nach vorn spring nach vorn auf [AppName]/[DeviceBrand] nächstes im [DeviceLocation] nächstes auf [DeviceLocation]? [DeviceType]/[DeviceBrand] gib mir das nächste von [AppName] nächstes auf allen [DeviceType] |
The next page of results appears on the screen. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
[GroupDeviceBrand] [HomeAutomationType] पर अगला लगाओ[GroupDeviceBrand] पर अगला लगाओ[GroupDeviceBrand] वाले [HomeAutomationType] पर अगला चलाना[AppName] पर इसके बाद वाला दो[AppName] पर मुझे next वाला दे देनाnext recipe अगली recipe[DeviceLocation] पर इसके बाद वाला दो[LocationNonSpecificQuantity] अगला चलाओ अगला/next [Episode] play करो[DeviceLocation] पर DeviceBrand अगला वाला दो |
The next page of results appears on the screen. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
prossima / seguente / avanti / salta / successivo |
The next page of results appears on the screen. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
次 スキップ 次に行って[DeviceLocation]で次に行って[DeviceLocation]の[DeviceBrand]で次に行って[LocationNonSpecificQuantity]で次を再生[Episode]を再生して[VideoName]の[Episode]を再生[DeviceBrand]で再生 |
The next page of results appears on the screen. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
próximo/próxima |
The next page of results appears on the screen. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Get Next Page Required for certification |
siguiente salta muestra el siguiente siguiente en el sonos próxima en el jardín |
The next page of results appears on the screen. |
Handling GetNextPage Directives
After receiving search results from your Lambda (through your GetDisplayableItemsMetadataResponse
), a user might want to see additional search results, or "the next page" of search results. Users can paginate to the next page of search results with a simple phrase such as "Get next page."
This prompts Alexa to send a GetNextPage
directive. Your Lambda response to this directive should include basic metadata for search results. The response is analogous to GetDisplayableItemsResponse
.
After Alexa receives your GetNextPageResponse
, Alexa will follow up with a GetDisplayableItemsMetadata
directive as more information is needed.
GetNextPage Example
The following is an example GetNextPage
directive. Note the minResultLimit
and maxResultLimit
for the items you must send.
{
"directive": {
"header": {
"correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
"messageId": "9f4803ec-4c94-4fdf-89c2-d502d5e52bb4",
"name": "GetNextPage",
"namespace": "Alexa.VideoContentProvider",
"payloadVersion": "3"
},
"endpoint": {
"cookie": {
},
"endpointId": "<the identifier of the target endpoint>",
"scope": {
"token": "<an OAuth2 bearer token>",
"type": "BearerToken"
}
},
"payload": {
"nextToken": "fvkjbr20dvjbkwOpqStr",
"minResultLimit": 8,
"maxResultLimit": 25
}
}
}
Payload Descriptions
The following table describes the payload
for GetNextPage
directives.
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 |
minResultLimit required |
The minimum number of results to return in this call for which a For a Example: |
Integer |
maxResultLimit required |
A limit to the maximum number of results to return. See description of Example: |
Integer |
Lambda Response
Your Lambda response should be a list of items to display on the device.
Response Example
The following is an example of the GetNextPageResponse
that your Lambda should send. This payload follows the same format as GetDisplayableItemsMetadata
.
{
"event": {
"header": {
"correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
"messageId": "9f4803ec-4c94-4fdf-89c2-d502d5e52bb4",
"name": "GetNextPageResponse",
"namespace": "Alexa.VideoContentProvider",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "Alexa-access-token"
},
"endpointId": "appliance-001"
},
"payload": {
"nextToken": "qefjrfiugef74",
"mediaItems": [
{
"mediaIdentifier": {
"id": "recordingId://provider1.dvr.rp.1234-2345-63434-asdf"
}
},
{
"mediaIdentifier": {
"id": "recordingId://provider1.dvr.rp.1234-2345-63434-asdf"
}
}
]
}
}
}
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 |
List |
mediaIdentifier required |
Identifier for the |
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 |
String |