Advanced End Session (Alexa) v3.0.1 Help ​

Delivers a message defined via JSON and ends the current Alexa session.

Note: Steps of the Alexa toolkit work only with existing custom Alexa skills with the method to host your skill's backend resources selected as Provision your own. The skill interaction model must be built with intents and slots on the Amazon developer colsole prior to building solutions with the Alexa toolkit.

How can I use the Step? ​

You can use this Step to force the end of the current interaction between Alexa and the end user. This is useful when the interaction has reached its natural conclusion.

The message delivered to the end user is formed using JSON and may include additional Alexa features (i.e. directives). It may be used, for example, to inform the end user about the result of the interaction.

Note: To end a session without sending a message, or sending a message using text to speech, prerecorded audio or Alexa SSML options, you can use the End Session (Alexa) Step.

How does the Step work? ​

You define the message content as JSON code. When this Step is reached in the Flow, Alexa delivers the defined message to the end user, ends the session, and the Flow proceeds down the Step's exit.

Warning! This Step should be used as the last Alexa Step that interacts with the end user in a Flow. The Flow logic built on its exit cannot be used to begin a new Alexa session.

Prerequisites ​

Before building Flows using the Alexa toolkit, you must complete the following steps:

  1. Create a Custom Alexa skill with at least one intent in the Amazon developers console. Read more on how to create Alexa skills here.
  2. Install the Alexa Skill Adapter flow. See the instruction here.
  3. Create an authorization of your OneReach.ai account with the Amazon developer account. See the instructions in the Add an authorization modal of the Authorization section of an Alexa Step.

Alexa Skill Adapter Flow ​

The Alexa Skill Adapter Flow is required to manage the interactions between OneReach.ai and the Amazon developer console. To install it take the following steps:

  1. Add any gateway Step template from the Alexa toolkit to the Flow. For example, a Wait for Intent (Alexa) Step.
  2. Go to the Details tab of the added Step. The Authorization collapsible group contains a warning message with the Install Adapter button. Click to install the adapter Flow. After the installation is completed, a respective message should appear.

Note: In case Alexa Skill Adapter Flow is deactivated or deleted, a respective alert will pop up in the gateway Step of the Flow with a button to fix the problem.

Message content ​

In this section you define the message that Alexa delivers to the end user in the Response JSON input.

Note: It is advisable to test the message in the Alexa development console to make sure it is reproduced correctly.

The Response JSON input is expected as JSON code and must contain an outbound message. You can also include a reprompt message and a card, as well as use directives. Learn more about response format and syntax here. A general structure of the response object is added to the field by default.

Warning! The shouldEndSession property is preset as true and should not be used in this input.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more about Reporting events, follow this link.

Services dependencies ​

  • Alexa Skill Adapter v3.0.0 or upper

Release notes ​