Alexa.Automotive.VehicleData Interface

Implement the Alexa.Automotive.VehicleData interface in your Alexa skill for connected vehicles to identify the make, model, year, and other information about a vehicle. For details, see Connected Vehicle Skills for Alexa.

The VehicleData interface is different than other Alexa interfaces in that you aren't directly supporting voice user interactions with Alexa. There are no utterances associated with this interface. Instead, you are enabling Alexa to provide vehicle-specific options, and to identify the correct vehicle when the user makes a request with an ambiguous target vehicle. The VehicleData interface defines no properties or directives, and doesn't participate in state or change reporting. Instead, you provide vehicle data in your discovery response.

For the list of languages that the VehicleData interface supports, see List of Alexa Interfaces and Supported Languages.

Discovery

You describe endpoints that support Alexa.Automotive.VehicleData using the standard discovery mechanism described in Alexa.Discovery.

Include only one instance of the VehicleData interface in your discover response, as a capability for the endpoint that represents the vehicle itself.

In addition to the usual discovery response fields, for VehicleData, include a configuration object that contains the following fields.

Field Description Type Required
Year The year of the vehicle. Integer Yes
resources Friendly names for the make, model, and trim of the vehicle. For details about friendly names, see Friendly Name Resources and Assets. Object Yes
resources.make A friendly name for the make of the vehicle. A label object. Yes
resources.model A friendly name for the model of the vehicle. A label object. Yes
resources.trim A friendly name for the trim of the vehicle. A label object. No
analytics.segments Information used for analytics, such as the operating system and hardware architecture of the vehicle. An array of objects that each contain a key/value. No

Discover response example

The following example shows a Discover.Response message for a car that supports the VehicleData and Alexa.PowerController interfaces.

For the full list of recommended interfaces for a car, see Interfaces for connected vehicle skills.

For a more complete Discover.Response example, see Discovery for connected vehicle skills.

Copied to clipboard.

{
  "event": {
    "header": {
      "namespace": "Alexa.Discovery",
      "name": "Discover.Response",
      "payloadVersion": "3",
      "messageId": "<message id>"
    },
    "payload": {
      "endpoints": [
        {
          "endpointId": "<unique ID of the vehicle endpoint>",
          "additionalAttributes":  {
            "serialNumber": "<the serial number of the vehicle>"
          },
          "endpointResources": {
            "manufacturerName": {
              "@type": "text",
              "value": {
                "text": "<the manufacturer name of the vehicle>",
                "locale": "en-US"
              }
            },
            "description": {
              "@type": "text",
                "value": {
                  "text": "<a description that appears in the Alexa app>",
                  "locale": "en-US"
                }
            },
            "friendlyNames": [
              {
                "@type": "text",
                "value": {
                  "text": "<device name that appears in the Alexa app, such as car>",
                  "locale": "en-US"
                }
              },
              {
                "@type": "text",
                "value": {
                  "text": "<additional device name, such as smart car>",
                  "locale": "en-US"
                }
              }
            ]
          },
          "displayCategories": ["VEHICLE"],
          "cookie": {},
          "capabilities": [
            {
              "type": "AlexaInterface",
              "interface": "Alexa.Automotive.VehicleData",
              "version": "1.0",
              "configuration": {
                "year": 2020,
                "resources": {
                  "make": {
                    "@type": "text",
                    "value": {
                      "text": "Chevrolet",
                      "locale": "en-US"
                    }
                  },
                  "model": {
                    "@type": "text",
                    "value": {
                      "text": "Silverado",
                      "locale": "en-US"
                    }
                  },
                  "trim": {
                    "@type": "text",
                    "value": {
                      "text": "LTZ",
                      "locale": "en-US"
                    }
                  }
                },
                "analytics": {
                  "segments": [
                    {
                      "key": "OPERATING_SYSTEM",
                      "value": "AndroidOreao_8.1"
                    },
                    {
                      "key": "HARDWARE_ARCHITECTURE",
                      "value": "x86_64"
                    },
                    {
                      "key": "MICROPHONE_TYPE",
                      "value": "7mic array centrally located"
                    },
                    {
                      "key": "GEOGRAPHY",
                      "value": "NA"
                    },
                    {
                      "key": "ALEXA_APPLICATION_VERSION",
                      "value": "2.2.1X"
                    }
                  ]
                }
              }
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa.PowerController",
              "version": "3",
              "properties": {
                "supported": [
                  {
                    "name": "powerState"
                  }
                ],
                "proactivelyReported": true,
                "retrievable": true
              }
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa",
              "version": "3"
            }
          ]
        }
      ]
    }
  }
}