{"id":18039,"date":"2018-02-08T11:49:44","date_gmt":"2018-02-08T11:49:44","guid":{"rendered":"http:\/\/developer.kore.ai\/v9-3\/?post_type=docs&p=13252"},"modified":"2022-09-30T18:34:36","modified_gmt":"2022-09-30T17:34:36","slug":"adding-the-amazon-alexa-channel","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-3\/docs\/bots\/channel-enablement\/adding-the-amazon-alexa-channel\/","title":{"rendered":"Adding the Amazon Alexa Channel"},"content":{"rendered":"

To add Amazon Alexa as a channel to your Kore.ai assistant, you must extract supported Dialog Tasks of this VA from the <\/span>Configurations<\/strong> tab and add to your Amazon Alexa\u2019s Skills. Additionally, you must configure your VA\u2019s <\/span>Webhook URL<\/span><\/em> as your Alexa Skill Set\u2019s Service Endpoint for the XO Platform to receive messages. To enable the Alexa channel, you must have or register for an Amazon Developer account.<\/span><\/p>\n\n\n\n
\n

Important Notes<\/span><\/span><\/h1>\n

Alexa as a channel must be enabled for VAs that are specifically built to work on voice-based channels. Review the following constraints before enabling Alexa as a channel:<\/span><\/p>\n

    \n
  1. Enterprise assistants that require the user\u2019s authorization to communicate with it are not supported.<\/span><\/li>\n
  2. If your dialog tasks require the user\u2019s authorization to communicate with external systems, then the Platform will push a card with URL information to the Alexa app.<\/span><\/li>\n
  3. Intents and entities of only Published Dialog Tasks can be exported to Amazon Alexa. Ensure that your intents and entities adhere to the naming guidelines of Amazon Alexa.<\/span><\/li>\n
  4. Not all entity types available in the Kore.ai Platform are currently available in Alexa. Verify that your tasks contain Alexa-supported entities for optimal user experience.<\/span><\/li>\n
  5. Ensure that your dialog tasks contain one or more utterances.<\/span><\/li>\n
  6. If you want to display responses as templates on supported devices like Echo Show, you must define channel-specific responses\/prompts.<\/span><\/li>\n
  7. Ensure that your dialog tasks contain the Message node as the last node only. Alexa marks a task as completed if a VA message is displayed without expecting any input from the user.<\/span><\/li>\n
  8. Webhook Nodes work asynchronously and are currently not supported.<\/span><\/li>\n
  9. Amazon Alexa executes one task at a time and hence the <\/span>Hold & Resume<\/strong> functionality is not supported.<\/span><\/li>\n<\/ol>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    <\/div><\/div>\n

    Setup Overview<\/span><\/span><\/h1>\n

    To add the Amazon Alexa channel, you must:<\/span><\/p>\n

      \n
    1. Add a New Skill<\/strong> \u2013 To enable the Alexa channel to your Kore.ai assistant, create a new Alexa skill in the Amazon developer console.<\/span><\/li>\n
    2. Configure the Interaction Model<\/strong> \u2013 Alexa skill can be built in one of the following ways:<\/span><\/li>\n
        \n
      1. Dialog Migration to extract the dialog tasks from Kore.ai and import them into Amazon Alexa\u2019s Skills. This will entail re-import for reflecting ongoing changes in the dialog definition. Intent detection and execution are primarily controlled by Alexa.<\/span><\/li>\n
      2. Redirection to create a single intent in your skill with one SearchQuery slot that accepts user inputs and redirects them to your Kore.ai VA. Intent detection and execution are primarily controlled by the Kore.ai VA.
        <\/span><\/li>\n<\/ol>\n
      3. Enable Account Linking <\/strong>\u2013 To access end user\u2019s authentication details to make API calls to external services. This step is optional.<\/span><\/li>\n
      4. Enable Webhook Integration<\/strong> \u2013 To integrate Amazon Alexa with your Kore.ai VA, enable webhook integration by copying the <\/span>Webhook URL<\/strong> provided on the <\/span>Configurations<\/strong> tab of the Amazon Alexa Channel page in the XO Platform and select <\/span>HTTPS<\/span><\/em> as Service Endpoint type.<\/span><\/li>\n
      5. Enable Channel<\/strong> \u2013 After completing the integration setup, enable the channel.<\/span><\/li>\n
      6. Test Integration<\/strong> \u2013 Once the channel is enabled, to validate a successful integration, test any intent utterance using the <\/span>Test<\/strong> tab of your Alexa Skill and check its responses for the given test utterances.<\/span><\/li>\n
      7. Distribution, Privacy & Compliance, and Certification <\/strong>\u2013 You must publish your Alexa Skill on Alexa App and provide details for Privacy and Compliance to enable <\/span>Skills Beta Testing<\/span><\/em> that allows you to invite your co-developers to test your app. You must also submit your Skill to Amazon for certification to enable your skill to become visible on Alexa Skills on Amazon App Store after it is certified.<\/span><\/li>\n<\/ol>\n
        <\/div><\/div>\n

        Step 1: Add a New Skill<\/span><\/span><\/h1>\n
          \n
        1. Log into your <\/span>Amazon Developer Portal<\/strong><\/a> and click the <\/span>Alexa<\/strong> tab. Choose <\/span>Skills<\/strong> from <\/span>Your Alexa Console <\/strong>and <\/span>Create a New Skill<\/strong>.\u00a0
          <\/span><\/li>\n
        2. In the <\/span>Create a New Alexa Skill<\/strong> section, enter the required information in the respective fields.<\/span>\n
            \n
          1. Choose if you want to <\/span>Sync Locale <\/strong>and select <\/span>Custom <\/strong>as a model to add to your skill.\u00a0\u00a0<\/span><\/li>\n
          2. Under Choose a method to host your skill’s backend resources, please select <\/span>Provision your own.
            \"\"<\/a><\/span>
            <\/strong><\/li>\n<\/ol>\n<\/li>\n
          3. Click <\/span>Create Skill<\/strong> at the top right of the page.<\/span><\/li>\n<\/ol>\n
            <\/div><\/div>\n

            Step 2: Configure the Interaction Model\u00a0<\/span><\/span><\/h1>\n
              \n
            1. Now, from under the Interaction Model section, select <\/span>JSON Editor<\/strong>.
              \"\"<\/a> <\/span><\/li>\n
            2. In the <\/span>Code Editor<\/strong>, define the intents and entities to associate with your newly created skill. For this, follow the steps below in the XO Platform:\u00a0\u00a0<\/span>\n
                \n
              1. Select the assistant you want to work with.<\/span><\/li>\n
              2. Go to <\/span>Deploy > Channels > Amazon Alexa > Configurations<\/strong>.<\/span><\/li>\n
              3. From under <\/span>Alexa Skill Definition JSON<\/strong>, download the VA\u2019s tasks as a JSON file to be uploaded into Alexa Skills JSON Editor.
                \"\"<\/a>
                <\/span><\/li>\n
              4. Upload the JSON file to the Alexa Code Editor, review and ensure that there are no errors, click <\/span>Save Model, <\/strong>then <\/span>Build Model<\/strong>.
                \"\"<\/a><\/span><\/span>
                \n\n\n\n
                \n

                Note<\/em><\/strong>: It takes 2-5 mins for the Model to build. Any changes implemented to the built model must be followed by rebuilding the model.<\/span><\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

                <\/div><\/div>\n

                Step 3: Enable Account Linking (Optional)<\/span><\/span><\/h1>\n

                You can enable the Account Linking feature in your Alexa Skill if your assistant expects end users\u2019 authorization for making API calls to external services.\u00a0<\/span><\/p>\n

                  \n
                1. Within your skill\u2019s <\/span>Build <\/strong>tab, go to <\/span>Tools<\/strong>.<\/span><\/li>\n
                2. Click on <\/span>Account Linking<\/strong> and set up the integration as per the instructions available from Amazon, and as per your requirements. Alexa requests users to provide the required authorization details for linking the accounts. During skill execution, Alexa shares the user access tokens with Kore.ai assistants, which are then used to make API calls defined in Service nodes.\u00a0
                  \"\"<\/a>
                  <\/span><\/li>\n<\/ol>\n
                  <\/div><\/div>\n

                  Step 4: Enable the Webhook Integration<\/span><\/span><\/h1>\n
                    \n
                  1. Go to the <\/span>Endpoint <\/strong>section.<\/span><\/li>\n
                  2. Select <\/span>HTTPS <\/strong>as the Service Endpoint Type. Copy the <\/span>Webhook URL<\/strong> provided in the <\/span>Configurations<\/strong> tab of the Amazon Alexa channel page in the XO Platform and enter it in the <\/span>Default<\/strong> textbox.<\/span><\/li>\n
                  3. In the <\/span>SSL Certificate <\/strong>dropdown, select the option <\/span>My development endpoint is a sub-domain of a domain that has a wildcard certificate from a certificate authority<\/strong>.<\/span><\/li>\n
                  4. Click Save <\/span>Endpoint<\/strong>.<\/span><\/li>\n<\/ol>\n
                    <\/div><\/div>\n

                    Step 5: Enable the Channel<\/span><\/span><\/h1>\n

                    Before you can start testing your assistant on Alexa, you must complete the channel setup. Go to the <\/span>Configurations<\/strong> tab of the Amazon Alexa channel page, review the details and select<\/span> Yes<\/strong>; click <\/span>Save<\/strong> to enable Amazon Alexa Channel.<\/span><\/p>\n

                    \"\"<\/a><\/span><\/p>\n

                    <\/div><\/div>\n

                    Step 6: Test the Integration<\/span><\/span><\/h1>\n

                    Once done, you can use the <\/span>Test <\/strong>tab of your Alexa Skill to test your utterances against the integration. In the <\/span>Test<\/strong> tab, go to the <\/span>Service Simulator<\/strong> section and provide any intent utterance and click <\/span>Ask <skill-name><\/strong> to test the utterance. If you get a successful response then the integration is considered a success.<\/span><\/p>\n

                    \"\"<\/a><\/span><\/p>\n

                    <\/div><\/div>\n

                    Step 7: Distribution<\/span><\/span><\/h1>\n

                    Now, go to the <\/span>Distribution <\/strong>tab and provide all the required details for publishing your Alexa Skill on the Alexa App and <\/span>Save<\/strong> the details.<\/span><\/p>\n

                    \"\"<\/a><\/span><\/p>\n

                    <\/div><\/div>\n

                    Privacy & Compliance<\/span><\/span><\/h1>\n

                    Next, go to the <\/span>Privacy & Compliance<\/strong> tab and provide all the required details requested and click <\/span>Save<\/strong>.\u00a0<\/span><\/p>\n

                    After completing these steps, the <\/span>Skills Beta Testing <\/strong>option is enabled and this allows you to invite your co-developers to test your app. <\/span><\/p>\n

                    When you are ready to submit your Skill to Amazon, <\/span>Submit for Certification<\/strong>. Your skill will be visible on <\/span>Alexa Skills<\/strong> on <\/span>Amazon App Store<\/strong> after it is certified.<\/span><\/p>\n

                    \"\"<\/a><\/span><\/p>\n

                    After the channel is enabled and all configurations are verified, you can optionally publish the assistant to make it available for end-users, with the new channel. Learn more about<\/span> Publishing your Virtual Assistant<\/span><\/a>.<\/span><\/p>\n

                    To learn more about working with Channels within the Kore.ai XO Platform, please see<\/span> Channel Enablement.<\/span><\/a><\/p>\n

                    <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

                    To add Amazon Alexa as a channel to your Kore.ai assistant, you must extract supported Dialog Tasks of this VA from the Configurations tab and add to your Amazon Alexa\u2019s Skills. Additionally, you must configure your VA\u2019s Webhook URL as your Alexa Skill Set\u2019s Service Endpoint for the XO Platform to receive messages. To enable…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25],"tags":[],"class_list":["post-18039","post","type-post","status-publish","format-standard","hentry","category-channel-enablement"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/18039","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/comments?post=18039"}],"version-history":[{"count":14,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/18039\/revisions"}],"predecessor-version":[{"id":46998,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/18039\/revisions\/46998"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/media?parent=18039"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/categories?post=18039"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/tags?post=18039"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}