Developer Console
Gracias por tu visita. Esta página solo está disponible en inglés.

Alexa.Launcher Interface (VSK Fire TV)

The Alexa.Launcher interface exposes directives for launching:

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 directive

Request to launch a specified application or custom shortcut. The application or custom 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 says, "Alexa, launch Prime Video"

LaunchTarget directive example

Copied to clipboard.

{
    "directive": {
        "header": {
            "correlationToken": "an opaque correlation token",
            "messageId": "a unique identifier, preferably a version 4 UUID",
            "name": "LaunchTarget",
            "namespace": "Alexa.Launcher",
            "payloadVersion": "3.1"
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "some-access-token"
            },
            "endpointId": "endpoint id",
            "cookie": {}
        },
        "payload": {
            "name": "Prime Video",
            "identifier": "amzn1.alexa-ask-target.app.72095",
            "sourceId": "ALEXA_VIDEO_APP_STORE",
            }
        }
    }
}

LaunchTarget directive parameters

Property Description Type Required
name The name associated with the identifier. String Yes
identifier The identifier for the item to launch. Application identifiers contain app, and custom shortcut identifiers contain shortcut. For a complete list of identifiers see the Launch Target Reference String Yes
sourceId Uniquely identifies the catalog.

Valid values for predefined catalogs: ALEXA_VIDEO_SHORTCUT_STORE, ALEXA_VIDEO_APP_STORE.
Valid value for custom shortcuts: DISCOVERY.
String Yes
experience.mode Suggests the mode to display the requested results. VOICE_OPTIMIZED indicates voice-centric results, such as a shorter search result list. Use DEFAULT when you don't support the value of mode.

Valid values: DEFAULT, VOICE_OPTIMIZED
String No

LaunchTarget response example

If you handle a LaunchTarget directive successfully, respond with an Alexa.Response event. Include the values of the target property in the context object.

Copied to clipboard.

{
    "event": {
        "header": {
            "namespace": "Alexa",
            "name": "Response",
            "messageId": "a unique identifier, preferably a version 4 UUID",
            "correlationToken": "an opaque correlation token that matches the request",
            "payloadVersion": "3"
        },
        "endpoint": {
            "endpointId": "endpoint id"
        },
        "payload": {}
    },
    "context": {
        "properties": [
            {
                "namespace": "Alexa.Launcher",
                "name": "target",
                "value": {
                    "name": "Prime Video",
                    "identifier": "amzn1.alexa-ask-target.app.72095"
                },
                "timeOfSample": "2021-12-01T18:20:50Z",
                "uncertaintyInMilliseconds": 500
            },
            {
                "namespace": "Alexa.EndpointHealth",
                "name": "connectivity",
                "value": {
                    "value": "OK"
                },
                "timeOfSample": "2021-12-01T18:20:50Z",
                "uncertaintyInMilliseconds": 0
            }
        ]
    }
}

Events and Properties

Reportable Properties

Property Name Type Description
target Target The launched app or custom shortcut.

Response

Send a 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.

Copied to clipboard.

{
    "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": "Prime 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. See the Error Handling documentation for more information.


Last updated: 12-29-2021