Ti ringraziamo per la visita. Questa pagina è per il momento disponibile solo in inglese.

Error Handling (VSK MM)

In the event of an error, you should return an error code in the response so that Alexa can take a specific action. For example, the error code might include a value of NOT_SUBSCRIBED for non-entitled content.

Structure of Error Messages

The payload of an ErrorResponse event must specify a type and a message.

  • type: One of the accepted type values](../device-apis/alexa-errorresponse.html#error-types) that indicates the kind of error that has occurred. Alexa uses this attribute to respond to the customer appropriately.
  • message: String that provides more information about the error. This information is not shared with the customer.

No Search Results Found

For video skills on multimodal devices, the following error should be used when no search results are found:

Error type Description
CONTENT_NOT_FOUND This value should be used to indicate that no content was found based on the criteria sent in the directive or that the content was not recognized by the content provider.

Example Error: CONTENT_NOT_FOUND

{
    "event": {
        "header": {
            "messageId": "4e02d3c8-85e8-4e32-8a1b-08c1d52122ad",
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/==",
            "name": "ErrorResponse",
            "namespace": "Alexa.Video",
            "payloadVersion": "3"
        },
        "endpoint": {
            "scope": {
                "type": "DirectedUserId",
                "directedUserId": "access-token-from-Amazon"
            },
            "endpointId": "videoDevice-001"
        },
        "payload": {
            "message": "optional information about the error that will be logged by Alexa",
            "type": "CONTENT_NOT_FOUND"
        }
    }
}

Example Error: NOT_SUBSCRIBED

{
    "event": {
        "header": {
            "messageId": "4e02d3c8-85e8-4e32-8a1b-08c1d52122ad",
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/==",
            "name": "ErrorResponse",
            "namespace": "Alexa.Video",
            "payloadVersion": "3"
        },
        "endpoint": {
            "scope": {
                "type": "DirectedUserId",
                "directedUserId": "access-token-from-Amazon"
            },
            "endpointId": "videoDevice-001"
        },
        "payload": {
            "message": "optional information about the error that will be logged by Alexa",
            "type": "NOT_SUBSCRIBED"
        }
    }
}

Error Types

The following table lists the options for type.

Type Description
ACTION_NOT_PERMITTED_FOR_CONTENT Indicates the content does not allow the action requested. For example, if the user tries to delete a recording that is marked as not deletable.
CONFIRMATION_REQUIRED Indicates an additional confirmation must occur before the requested action can be completed.
CONTENT_NOT_RECORDABLE Indicates the record operation failed due to restrictions on the content.
NOT_SUBSCRIBED The user is not subscribed to the content for a channel or other subscription-based content.
RECORDING_EXISTS Indicates that a recording request failed because the recording already exists.
STORAGE_FULL Indicates that a recording request failed because the DVR storage is full.
TITLE_DISAMBIGUATION_REQUIRED Indicates the title specified yielded multiple results, and disambiguation is required to determine the program to record. This value should be used to indicate that the target device will provide a mechanism for disambiguation. For example, this error could indicate that there are multiple airings of a program or that the entity requested for recording has multiple programs associated with it.
TUNER_OCCUPIED Indicates that a recording request failed because of a scheduling conflict with another recording.