Alexa.Launcher Interface
The Alexa.Launcher interface exposes directives for launching:
- Application targets such as Amazon Video
- GUI shortcut targets such as Home or Settings
Directives to launch targets include a name and identifier from a list of predefined launch targets. You should review the list of launch targets and make sure your skill can correctly resolve items that support the skill's functionality.
For the list of locales that are supported for the Launcher interface, see List of Capability Interfaces and Supported Locales.
Directives
LaunchTarget
Request to launch a specified application or shortcut. The application or shortcut named by the user is matched to an identifier in a predefined launch target list list and the name and identifier is sent in the request.
User: Alexa, launch Amazon Video
Example: Launch Amazon Video
{
"directive": {
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "some-access-token"
},
"endpointId": "endpoint-001",
"cookie": {}
},
},
"header": {
"correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8pt90jSqg==",
"messageId": "abc-123-def-456",
"name": "LaunchTarget",
"namespace": "Alexa.Launcher",
"payloadVersion": "3"
},
"payload": {
"identifier": "amzn1.alexa-ask-target.app.72095",
"name": "Amazon Video"
}
}
}
Payload details
| Property | Description | Type | Required |
|---|---|---|---|
identifier |
The identifier for the item to launch. Application identifiers contain app, and shortcut identifiers contain shortcut. For a complete list of identifiers see the Launch Target Reference |
String | Yes |
name |
The name associated with the identifier. | String | Yes |
Events and Properties
Reportable Properties
| Property Name | Type | Description |
|---|---|---|
| target | Target | The launched app or shortcut. |
Response
Send an Response when you successfully handle a LaunchTarget directive.
Example Response
The following example shows a Response message. Report the value of the target property in the context of the message.
{
"context": {
"properties": [
{
"name": "target",
"namespace": "Alexa.Launcher",
"timeOfSample": "2017-05-06T16:20:50.52Z",
"uncertaintyInMilliseconds": 0,
"value": {
"identifier": "amzn1.alexa-ask-target.app.72095",
"name": "Amazon Video"
}
}
]
},
"event": {
"header": {
"correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8pt90jSqg==",
"messageId": "abc-123-def-456",
"name": "Response",
"namespace": "Alexa",
"payloadVersion": "3"
},
"payload": {}
}
}
ErrorResponse
You should reply with an error if you cannot complete the customer request for some reason.
- For video-specific errors, see Video.ErrorResponse
- For general errors, such as authentication and connection problems, see Error.Response.
