Microsoft Teams
Objective:
This document will show you how to create chat bots in Microsoft teams and use them to interact with custom apps in the Voiceworx platform
Goal:
The VoiceWorx platform can define different types of skills part of which are custom apps, search app, survey skills and QA skills. Our goal is to demonstrate our Microsoft Teams custom chat bot can be set to interact with the Voiceworx platform and interact with these skills. Please note that as at the time of this documentation, Microsoft Teams chat bot can only interact with the custom apps that do not require account linking.
Steps to Create the Chat bot
The following shows the general steps/activities that will be carried out in setting up this integration. Note it is assumed your admin has setup the appropriate permission that allows you to create an app in Microsoft Teams
Open Microsoft Teams and click on Apps
In the resulting page search for Apps Studio and click on the app studio tab
Click open button in the resulting modal page
Select Manifest Editor in the Menu bar and click the Create New App Button
Fill in the following details
Short name: A short descriptive name for your app e.g., VWQA.
Full name: e.g., Voiceworx Q A.
App ID: Click on the “Generate” button
Package Name: Use a reversal of your domain e.g., ai.voiceworx.test
Short description: Question and Answer
Full Description: Voiceworx question and answer Microsoft Teams skill
Developer Company Name: Enter your company name e.g., Voiceworx
Website: Your company website e.g., www.voiceworx.ai
Privacy Policy URL: Your company privacy policy e.g., http://www.voiceworx.ai/privacy.html
Terms of use url: Your company privacy policy e.g., http://www.voiceworx.ai/termsofuse.html
Under the “Capabilities” section of the menu, click on “Bots” -> “Set Up”
Click “Create Bot”
In the resulting Edit Bot Page click “Generate Password”
Set “Bot Endpoint Address” to https://teamstest.voiceworx.ai/api/messages
Now, let’s install the App.
Steps For Installing a Bot
ensure you are on the “Manifest Editor Tab”. In the view body, click the vertical ellipse in the skill you want to publish and select “Edit”.
On the edit page, scroll down on the submenu pane on the left to the Finish section. Select the “Test and Distribute” option
Now the app shall be available for testing.
Before that, let’s integrate the app in VoiceWorx portal to this Microsoft Teams Bot. Save the App Id that has been generated in Step 5. Follow this document to complete the integration. The user has to create a publish profile in VoiceWorx and provide the above App Id as reference to the Teams Bot.
Make sure that the integration has been performed before you head to the next step i.e., Test the App.
Test The App
You need to contact the VoiceWorx support team to help you set up a dedicated service to link up your VoiceWorx custom app and Teams Bot. After you have ensured that the setup is done from VoiceWorx side, you can continue with testing your app using following steps as guide.
Click on the 3 horizontal dots in the menu
Select the newly created app
Steps For Publishing a Bot
Click the horizontal ellipse on the menu bar and select “App Studio” from the options
In App studio, ensure you are on the “Manifest Editor Tab”. In the view body, click the vertical ellipse in the skill you want to publish and select “Edit”
On the edit page, scroll down on the submenu pane on the left to the Finish section. Select the “Test and Distribute” option
Select the “Publish” option
These are publishing options.
Publishing to your organization app catalog
Publish to Microsoft App Source
If you want to publish to your organization’s app catalog, use the first option. This will make the Bot only visible to people with your organization. If you want the skill visible in the global Microsoft App store, use the second option
Note: If you are not the organization admin for the Teams platform, your skill will need to be approved by the admin. The approval flow occurs in the Microsoft Office 365 platform. The admin can follow this official documentation for the approval flow. https://docs.microsoft.com/en-us/microsoftteams/app-permissions-admin-center
Once the Bot is approved by your admin any user in your organization can access the bot by clicking on the “Apps” Icon at the base on the side menu. The skill will be visible in the resulting options as shown in the image below
Last updated