Settings Interface (v1.0)
The Settings interface is used to manage Alexa settings on your product, such as locale.
Capabilities API
To use version 1.0 of the Settings interface, it must be declared in your call to the Capabilities API. For additional details, see Capabilities API.
{
"type": "AlexaInterface",
"interface": "Settings",
"version": "1.0"
}
SettingsUpdated Event
The SettingsUpdated event must be sent when Alexa settings are adjusted using on-product controls or a companion app. For example, your user may change their locale setting from US (en-US) to Germany (de-DE) using your companion app. When this happens, your client must notify Alexa of the change with the SettingsUpdated event.
Note: If a malformed or unsupported value is sent to Alexa an exception message is returned.
Sample Message
{
"event": {
"header": {
"namespace": "Settings",
"name": "SettingsUpdated",
"messageId": "{{STRING}}"
},
"payload": {
"settings": [
{
"key": "{{STRING}}",
"value": "{{STRING}}"
}
]
}
}
}
Header Parameters
| Parameter | Description | Type |
|---|---|---|
| messageId | A unique ID used to represent a specific message. | string |
Payload Parameters
| Parameter | Description | Type |
|---|---|---|
| settings | A list of Alexa settings for a product. Each item in the list is an object with key/value pairs. | list |
| key | Identifies the key. Use the table below to identify accepted keys. | string |
| value | Identifies the key's value. Use the table below to identify accepted values for each key. | string |
Accepted Key/Value Pairs
| Accepted Keys | Accepted Values |
|---|---|
locale |
de-DE, en-AU, en-CA, en-GB, en-IN, en-US, es-ES, es-MX, fr-CA, fr-FR, it-IT, ja-JP |