Alexa.Commissionable.ReportCommissioningInformation.ErrorResponse Events
If Alexa sends an Alexa.Commissionable.ReportCommissioningInformation
directive to your skill and you can't handle it successfully, respond with an ReportCommissioningInformation.ErrorResponse
event. For details, see Alexa.Commissionable
Interface.
ErrorResponse event
In the payload for the ReportCommissioningInformation.ErrorResponse
, specify the type of the error and include a message with information about the error. For the list of ReportCommissioningInformation
error types, see Error type values.
ReportCommissioningInformation.ErrorResponse payload
The following table shows the error response payload for Alexa.Commissionable.ReportCommissioningInformation
.
Property | Description | Type | Required |
---|---|---|---|
|
Error type values encountered by the skill when trying to return commissioning information. |
String |
Yes |
|
Error description. |
String |
No |
ErrorResponse event format
{
"event": {
"header": {
"namespace": "Alexa.Commissionable",
"name": "ReportCommissioningInformation.ErrorResponse",
"messageId": "message id",
"payloadVersion": "1.0"
},
"endpoint": {
"endpointId": "unique endpoint id"
},
"payload": {
"type": "error type",
"message": "error message"
}
}
}
Error type values
The following table shows the valid Alexa.Commissionable.ReportCommissioningInformation
error types.
Value | Description |
---|---|
|
Endpoint was already commissioned with the maximum number of local hubs. |
|
Endpoint is reachable but is unable to accept local connection. For Matter, it might mean that the endpoint failed to put the device into commissioning mode. |
In addition to the ReportCommissioningInformation
error types, you can use standard Alexa error types, such as ENDPOINT_BUSY
, ENDPOINT_UNREACHABLE
, and BRIDGE_UNREACHABLE
. For details, see Alexa ErrorResponse event 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.Commissionable.ReportCommissioningInformation
error types, see Error type values.
{
"event": {
"header": {
"namespace": "Alexa.Commissionable",
"name": "ReportCommissioningInformation.ErrorResponse",
"messageId": "a unique identifier, preferably a version 4 UUID",
"payloadVersion": "1.0"
},
"endpoint":{
"endpointId": "unique endpoint id"
},
"payload": {
"type": "MAX_COMMISSIONING_LIMIT_REACHED",
"message": "Endpoint was already commissioned with the maximum number of local hubs."
}
}
}
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.Commissionable.ReportCommissioningInformation
error types, see Error type values.
{
"event": {
"header": {
"namespace": "Alexa.Commissionable",
"name": "ReportCommissioningInformation.ErrorResponse",
"messageId": "a unique identifier, preferably a version 4 UUID",
"correlationToken": "an opaque correlation token",
"payloadVersion": "1.0"
},
"endpoint":{
"scope":{
"type":"BearerToken",
"token":"access-token-from-Amazon"
},
"endpointId": "unique endpoint id"
},
"payload": {
"type": "MAX_COMMISSIONING_LIMIT_REACHED",
"message": "Endpoint was already commissioned with the maximum number of local hubs."
}
}
}