Alexa.ThermostatController.Schedule.ErrorResponse Events
If Alexa sends an Alexa.ThermostatController.Schedule
directive to your skill and you can't handle it successfully, respond with an Alexa.ThermostatController.Schedule.ErrorResponse
event. For details, see Alexa.ThermostatController.Schedule
.
ErrorResponse event
In the payload for the Alexa.ThermostatController.Schedule.ErrorResponse
, specify the type of the error and include a message with information about the error. For the list of Alexa.ThermostatController.Schedule
error types, see Error type values.
ErrorResponse event parameters
Field | Description | Type | Required |
---|---|---|---|
type |
The type of error. Alexa shares this with the customer. | String | Yes |
message |
The error message for the error. Alexa doesn't share this with the customer. | String | Yes |
ErrorResponse event example
{
"event": {
"header": {
"namespace": "Alexa.ThermostatController.Schedule",
"name": "ErrorResponse",
"messageId": "a unique identifier, preferably a version 4 UUID",
"correlationToken": "correlation token received in the directive",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2 bearer token"
},
"endpointId" : "the endpoint identifier" ,
},
"payload": {
"type": "<error type>",
"message": "<error message>"
}
}
}
Error type values
The following table shows the valid Alexa.ThermostatController.Schedule
error types.
Error Type | Description |
---|---|
INSUFFICIENT_SPACE |
Thermostat has insufficient space. This error might occur when the user set too many schedules and exceeded the device limit. |
In addition to the Alexa.ThermostatController.Schedule.ErrorResponse
error types, you can also use Alexa error types, such as INVALID_VALUE
or TEMPERATURE_VALUE_OUT_OF_RANGE
. For details, see Alexa.ErrorResponse
error type values.
Examples
Synchronous response example
The following is an example error response that you send synchronously to Alexa. For the list of Alexa.ThermostatController.Schedule.ErrorResponse
error types, see Error type values.
{
"event": {
"header": {
"namespace": "Alexa.ThermostatController.Schedule",
"name": "ErrorResponse",
"messageId": "a unique identifier, preferably a version 4 UUID",
"correlationToken": "correlation token received in the directive",
"payloadVersion": "3"
},
"endpoint":{
"endpointId": "endpoint id"
},
"payload": {
"type": "INSUFFICIENT_SPACE",
"message": "User exceeded limit for number of schedule entries."
}
}
}
Asynchronous response example
The following is an example error response that you send asynchronously to the Alexa event gateway. If you respond asynchronously, include a correlation token and a scope with an authorization token. For details, see Send Events to the Event Gateway.
For the list of Alexa.ThermostatController.Schedule
error types, see Error type values.
{
"event": {
"header": {
"namespace": "Alexa.ThermostatController.Schedule",
"name": "ErrorResponse",
"messageId": "a unique identifier, preferably a version 4 UUID",
"correlationToken": "correlation token received in the directive",
"payloadVersion": "3"
},
"endpoint":{
"scope":{
"type": "BearerToken",
"token": "OAuth2 bearer token"
},
"endpointId": "endpoint id"
},
"payload": {
"type": "INSUFFICIENT_SPACE",
"message": "User exceeded limit for number of schedule entries."
}
}
}