Alexa.AuthorizationController.ErrorResponse Interface 1.0

If Alexa sends an Alexa.AuthorizationController directive to your skill and you can't handle it successfully, respond with an Alexa.AuthorizationController.ErrorResponse event. For details, see Alexa.AuthorizationController Interface.

ErrorResponse event

In the payload for the Alexa.AuthorizationController.ErrorResponse, specify the type of the error and include a message with information about the error. For the list of Alexa.AuthorizationController error types, see Error type values. You can send a synchronous or an asynchronous response. For more details, see Alexa.ErrorResponse.

ErrorResponse event format

Copied to clipboard.

{
"event": {
    "header": {
      "namespace": "Alexa.AuthorizationController",
      "name": "ErrorResponse",
      "messageId": "Unique identifier, preferably a version 4 UUID",
      "payloadVersion": "1.0"
    },
    "endpoint": {
            "endpointId": "Endpoint id"
        },
    "payload": {
      "type": "Error type",
      "message": "Error message"
    }
  }
}

ErrorResponse event payload properties

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

Error type values

The following table shows the valid Alexa.AuthorizationController error type values.

Value Description
EXCEEDED_PIN_ATTEMPTS The user has entered an incorrect PIN too many times.
PIN_SETUP_REQUIRED The user hasn't set up their PIN code yet.
UNAUTHORIZED The PIN code is incorrect.

In addition to the Alexa.AuthorizationController error types, you can also use Alexa error types. For details, see Alexa.ErrorResponse error type values.

Alexa.AuthorizationController.ErrorResponse examples

The following examples show the payload for different error types.

UNAUTHORIZED example

The following is an example error response for the UNAUTHORIZED error type.

Copied to clipboard.

{
  "event": {
    "header": {
      "namespace": "Alexa.AuthorizationController",
      "name": "ErrorResponse",
      "messageId": "Unique identifier, preferably a version 4 UUID",
      "correlationToken": "Opaque correlation token that matches the request",
      "payloadVersion": "1.0"
    },
    "endpoint":{
      "endpointId": "Endpoint ID"
    },
    "payload": {
      "type": "UNAUTHORIZED",
      "message": "The PIN code is not correct."
    }
  }
}
Was this page helpful?

Last updated: Nov 22, 2023