ask-sdk-model

property 'applicationId'

applicationId: string;

• A string representing the application identifier for your skill.

property 'result'

result?: any;

• This is the result object to resume the skill's suspended session.

property 'status'

status?: Status;

property 'token'

token?: string;

• This is an echo back string that skills send when during Connections.StartConnection directive. They will receive it when they get the SessionResumedRequest. It is never sent to the skill handling the request.

property 'type'

type: 'ConnectionCompleted';

property 'Alexa.DataStore.PackageManager'

'Alexa.DataStore.PackageManager'?: interfaces.alexa.datastore.packagemanager.PackageManagerState;

• Provides the current state for the Alexa.DataStore.PackageManager interface.

property 'Alexa.Presentation.APL'

'Alexa.Presentation.APL'?: interfaces.alexa.presentation.apl.RenderedDocumentState;

• Provides the current state for the Alexa.Presentation.APL interface.

property 'Alexa.Presentation'

'Alexa.Presentation'?: interfaces.alexa.presentation.PresentationState;

• Provides the current state for the Alexa.Presentation interface.

property 'AppLink'

AppLink?: interfaces.applink.AppLinkState;

• Provides the current state for app link capability.

property 'AudioPlayer'

AudioPlayer?: interfaces.audioplayer.AudioPlayerState;

• Provides the current state for the AudioPlayer interface.

property 'Automotive'

Automotive?: interfaces.automotive.AutomotiveState;

• Provides the automotive specific information of the device.

property 'Display'

Display?: interfaces.display.DisplayState;

• Provides the current state for the Display interface.

property 'Experimentation'

Experimentation?: interfaces.alexa.experimentation.ExperimentationState;

• Provides the current experimentation state

property 'Extensions'

Extensions?: interfaces.alexa.extension.ExtensionsState;

• Provides the current state for Extensions interface

property 'Geolocation'

Geolocation?: interfaces.geolocation.GeolocationState;

• Provides the last gathered geolocation information of the device.

property 'System'

System: interfaces.system.SystemState;

• Provides information about the current state of the Alexa service and the device interacting with your skill.

property 'Viewport'

Viewport?: interfaces.viewport.ViewportState;

• Provides the characteristics of a device's viewport.

property 'Viewports'

Viewports?: Array<interfaces.viewport.TypedViewportState>;

• This object contains a list of viewports characteristics related to the device's viewports.

property 'deviceId'

deviceId: string;

• The deviceId property uniquely identifies the device. This identifier is scoped to a skill. Normally, disabling and re-enabling a skill generates a new identifier.

property 'persistentEndpointId'

persistentEndpointId?: string;

• A persistent identifier for the Endpoint ID where the skill request is issued from. An endpoint represents an Alexa-connected Endpoint (like an Echo device, or an application) with which an Alexa customer can interact rather than a physical device, so it could represent applications on your fire TV or your Alexa phone app. The persistentEndpointId is a string that represents a unique identifier for the endpoint in the context of a request. It is in the Amazon Common Identifier format "amzn1.alexa.endpoint.did.{id}". This identifier space is scoped to a vendor, therefore it will stay the same regardless of skill enablement.

property 'supportedInterfaces'

supportedInterfaces: SupportedInterfaces;

• Lists each interface that the device supports. For example, if supportedInterfaces includes AudioPlayer {}, then you know that the device supports streaming audio using the AudioPlayer interface

property 'confirmationStatus'

confirmationStatus: IntentConfirmationStatus;

property 'name'

name: string;

• A string representing the name of the intent.

property 'slots'

slots?: {
    [key: string]: Slot;
};

• A map of key-value pairs that further describes what the user meant based on a predefined intent schema. The map can be empty.

property 'dialogState'

dialogState: DialogState;

• Enumeration indicating the status of the multi-turn dialog. This property is included if the skill meets the requirements to use the Dialog directives. Note that COMPLETED is only possible when you use the Dialog.Delegate directive. If you use intent confirmation, dialogState is considered COMPLETED if the user denies the entire intent (for instance, by answering “no” when asked the confirmation prompt). Be sure to also check the confirmationStatus property on the Intent object before fulfilling the user’s request.

property 'intent'

intent: Intent;

• An object that represents what the user wants.

property 'locale'

locale?: string;

• A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

property 'requestId'

requestId: string;

• Represents the unique identifier for the specific request.

property 'timestamp'

timestamp: string;

• Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.

property 'type'

type: 'IntentRequest';

property 'locale'

locale?: string;

• A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

property 'requestId'

requestId: string;

• Represents the unique identifier for the specific request.

property 'task'

task?: Task;

property 'timestamp'

timestamp: string;

• Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.

property 'type'

type: 'LaunchRequest';

property 'type'

type: 'List';

property 'values'

values: Array<SlotValue>;

• An array containing the values captured for this slot.

property 'consentToken'

consentToken?: string;

• A token listing all the permissions granted for this user.

property 'scopes'

scopes?: {
    [key: string]: Scope;
};

• A map where the key is a LoginWithAmazon(LWA) scope and value is a list of key:value pairs which describe the state of user actions on the LWA scope. For e.g. "scopes" :{ "alexa::devices:all:geolocation:read":{"status":"GRANTED"}} This value of "alexa::devices:all:geolocation:read" will determine if the Geolocation data access is granted by the user, or else it will show a card of type AskForPermissionsConsent to the user to get this permission.

property 'accessToken'

accessToken?: string;

• A token identifying the user in another system. This is only provided if the recognized user has successfully linked their skill account with their Alexa profile. The accessToken field will not appear if null.

property 'personId'

personId?: string;

• A string that represents a unique identifier for the person who is interacting with Alexa. The length of this identifier can vary, but is never more than 255 characters. It is generated when a recognized user makes a request to your skill.

property 'context'

context: Context;

• The context object provides your skill with information about the current state of the Alexa service and device at the time the request is sent to your service. This is included on all requests. For requests sent in the context of a session (LaunchRequest and IntentRequest), the context object duplicates the user and application information that is also available in the session.

property 'request'

request: Request;

• A request object that provides the details of the user’s request.

property 'session'

session?: Session;

• The session object provides additional context associated with the request.

property 'version'

version: string;

• The version specifier for the request.

property 'apiResponse'

apiResponse?: any;

• API response object containing API response value(s)

property 'canFulfillIntent'

canFulfillIntent?: canfulfill.CanFulfillIntent;

property 'card'

card?: ui.Card;

property 'directives'

directives?: Array<Directive>;

property 'experimentation'

experimentation?: interfaces.alexa.experimentation.ExperimentTriggerResponse;

• Experiment trigger response from skill

property 'outputSpeech'

outputSpeech?: ui.OutputSpeech;

property 'reprompt'

reprompt?: ui.Reprompt;

property 'shouldEndSession'

shouldEndSession?: boolean;

property 'response'

response: Response;

property 'sessionAttributes'

sessionAttributes?: {
    [key: string]: any;
};

property 'userAgent'

userAgent?: string;

property 'version'

version: string;

property 'status'

status?: PermissionStatus;

property 'application'

application: Application;

property 'attributes'

attributes?: {
    [key: string]: any;
};

• A map of key-value pairs. The attributes map is empty for requests where a new session has started with the property new set to true. When returning your response, you can include data you need to persist during the session in the sessionAttributes property. The attributes you provide are then passed back to your skill on the next request.

property 'new'

new: boolean;

• A boolean value indicating whether this is a new session. Returns true for a new session or false for an existing session.

property 'sessionId'

sessionId: string;

• A string that represents a unique identifier per a user’s active session.

property 'user'

user: User;

• An object that describes the user making the request.

property 'message'

message: string;

• A string providing more information about the error.

property 'type'

type: SessionEndedErrorType;

• A string indicating the type of error that occurred.

property 'error'

error?: SessionEndedError;

• An error object providing more information about the error that occurred.

property 'locale'

locale?: string;

• A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

property 'reason'

reason: SessionEndedReason;

• Describes why the session ended.

property 'requestId'

requestId: string;

• Represents the unique identifier for the specific request.

property 'timestamp'

timestamp: string;

• Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.

property 'type'

type: 'SessionEndedRequest';

property 'cause'

cause?: Cause;

property 'locale'

locale?: string;

• A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

property 'requestId'

requestId: string;

• Represents the unique identifier for the specific request.

property 'timestamp'

timestamp: string;

• Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.

property 'type'

type: 'SessionResumedRequest';

property 'resolutions'

resolutions?: slu.entityresolution.Resolutions;

• Contains the results of entity resolution. These are organized by authority. An authority represents the source for the data provided for the slot. For a custom slot type, the authority is the slot type you defined.

property 'type'

type: 'Simple';

property 'value'

value?: string;

• A string that represents the value the user spoke for the slot. This is the actual value the user spoke, not necessarily the canonical value or one of the synonyms defined for the entity. Note that AMAZON.LITERAL slot values sent to your service are always in all lower case.

property 'confirmationStatus'

confirmationStatus: SlotConfirmationStatus;

• Indication of whether an intent or slot has been explicitly confirmed or denied by the user, or neither.

property 'name'

name: string;

• A string that represents the name of the slot.

property 'resolutions'

resolutions?: slu.entityresolution.Resolutions;

• Contains the resultsof entity resolution. These are organized by authority. An authority represents the source for the data provided for the slot. For a custom slot type, the authority is the slot type you defined.

property 'slotValue'

slotValue?: SlotValue;

• Object representing the value of the slot.

property 'value'

value?: string;

• A string that represents the value the user spoke for the slot. This is the actual value the user spoke, not necessarily the canonical value or one of the synonyms defined for the entity. Note that AMAZON.LITERAL slot values sent to your service are always in all lower case.

property 'code'

code: string;

• This is a code signifying the status of the execution initiated by the skill. Protocol adheres to HTTP status codes.

property 'message'

message: string;

• This is a message that goes along with response code that can provide more information about what occurred.

property 'Alexa.Advertisement'

'Alexa.Advertisement'?: interfaces.alexa.advertisement.AlexaAdvertisementInterface;

property 'Alexa.Presentation.APL'

'Alexa.Presentation.APL'?: interfaces.alexa.presentation.apl.AlexaPresentationAplInterface;

property 'Alexa.Presentation.APLT'

'Alexa.Presentation.APLT'?: interfaces.alexa.presentation.aplt.AlexaPresentationApltInterface;

property 'Alexa.Presentation.HTML'

'Alexa.Presentation.HTML'?: interfaces.alexa.presentation.html.AlexaPresentationHtmlInterface;

property 'AppLink'

AppLink?: interfaces.applink.AppLinkInterface;

property 'AudioPlayer'

AudioPlayer?: interfaces.audioplayer.AudioPlayerInterface;

property 'Display'

Display?: interfaces.display.DisplayInterface;

property 'Geolocation'

Geolocation?: interfaces.geolocation.GeolocationInterface;

property 'Navigation'

Navigation?: interfaces.navigation.NavigationInterface;

property 'VideoApp'

VideoApp?: interfaces.videoapp.VideoAppInterface;

property 'input'

input?: any;

• Represents the input to handle the task.

property 'name'

name: string;

• Represents the name of the task.

property 'version'

version: string;

• Represents the version of the task.

property 'accessToken'

accessToken?: string;

• A token identifying the user in another system. This is only provided if the user has successfully linked their skill account with their Amazon account.

property 'permissions'

permissions?: Permissions;

property 'userId'

userId: string;

• A string that represents a unique identifier for the user who made the request. The length of this identifier can vary, but is never more than 255 characters. The userId is automatically generated when a user enables the skill in the Alexa app. Note: Disabling and re-enabling a skill generates a new identifier.

type GrantType

type GrantType = 'OAuth2.AuthorizationCode';

• One of the grant types supported.

type CanFulfillIntentValues

type CanFulfillIntentValues = 'YES' | 'NO' | 'MAYBE';

• Overall if skill can understand and fulfill the intent with detected slots. Respond YES when skill understands all slots, can fulfill all slots, and can fulfill the request in its entirety. Respond NO when skill either cannot understand the intent, cannot understand all the slots, or cannot fulfill all the slots. Respond MAYBE when skill can understand the intent, can partially or fully understand the slots, and can partially or fully fulfill the slots. The only cases where should respond MAYBE is when skill partially understand the request and can potentially complete the request if skill get more data, either through callbacks or through a multi-turn conversation with the user.

type CanFulfillSlotValues

type CanFulfillSlotValues = 'YES' | 'NO';

• This field indicates whether skill can fulfill relevant action for the slot, that has been partially or fully understood. The definition of fulfilling the slot is dependent on skill and skill is required to have logic in place to determine whether a slot value can be fulfilled in the context of skill or not. Return YES if Skill can certainly fulfill the relevant action for this slot value. Return NO if skill cannot fulfill the relevant action for this slot value. For specific recommendations to set the value refer to the developer docs for more details.

type CanUnderstandSlotValues

type CanUnderstandSlotValues = 'YES' | 'NO' | 'MAYBE';

• This field indicates whether skill has understood the slot value. In most typical cases, skills will do some form of entity resolution by looking up a catalog or list to determine whether they recognize the slot or not. Return YES if skill have a perfect match or high confidence match (for eg. synonyms) with catalog or list maintained by skill. Return NO if skill cannot understand or recognize the slot value. Return MAYBE if skill have partial confidence or partial match. This will be true when the slot value doesn’t exist as is, in the catalog, but a variation or a fuzzy match may exist. For specific recommendations to set the value refer to the developer docs for more details.

type DelegationPeriodUntil

type DelegationPeriodUntil = 'EXPLICIT_RETURN' | 'NEXT_TURN';

• The end of the specified delegation period. * EXPLICIT_RETURN - delegation lasts until the targeted dialog manager returns a delegate with a new target. * NEXT_TURN - delegation lasts until the next turn, which resumes with the current focused dialog manager.

type UpdatedRequest

type UpdatedRequest = dialog.UpdatedInputRequest | dialog.UpdatedIntentRequest;

• The updated request to delegate. Null will delegate the current request.