kimtth / teams-speech-bot-plugin-azure

👺Microsoft Teams Speech Bot Demo

Teams Conversation Bot

Integration with The Speech service, part of Azure Cognitive Services

Bot Framework v4 Conversation Bot for Teams.

This bot has been created using Bot Framework. This sample shows how to incorporate basic conversational flow into a Teams application. It also illustrates a few of the Teams specific calls you can make from your bot.

Prerequisites

• Microsoft Teams is installed and you have an account
• .NET Core SDK version 3.1
• ngrok or equivalent tunnelling solution

To try this sample

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

1. Clone the repository

   git clone https://github.com/{userId}/teams-minutes-bot-plugin-azure.git

2. Run ngrok - point to port 3978

   ngrok http 3978 -host-header="localhost:3978"

3. Create Bot Framework registration resource in Azure

   • Use the current https URL you were given by running ngrok. Append with the path /api/messages used by this sample
   • Ensure that you've enabled the Teams Channel
   • If you don't have an Azure account you can use this Bot Framework registration

4. Update the appsettings.json configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)

5. This step is specific to Teams.

   • Edit the manifest.json contained in the teamsAppManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
   • Zip up the contents of the teamsAppManifest folder to create a manifest.zip
   • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

6. Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.

Interacting with the bot

You can interact with this bot by sending it a message, or selecting a command from the command list. The bot will respond to the following strings.

1. Start Recording

• Result: The bot will send a request to Speech SDK for starting voice recognition.
• During Recognizing

• Recognized: The bot will send a response of speech recognition result with translated text, which is translated by Azure Translate, part of Azure Cognitive Service. Simultaneously, The Recognizing Dialog is going to be deleted.

2. Stop Recording

• Result: The bot will send a request to Speech SDK for stopping voice recognition.

3. Me

• Result: The bot will send a response of who is a current user that is fetched from Teams Context.

4. Help

• Result: The bot will send the welcome card with supported commands list.

5. Settings

• Result: The configuration dialog for setting source language of Speech recognition.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading

• How Microsoft Teams bots work