SimRUN is a Microsoft Teams conversation bot created to manage a Virtual Running event.
'SimRUN' allowed people to log their entry for the day in terms of "How many kms run" The architecture consisted of a webservice and a SQL database. Azure WebService provided APIs to interact and saved the data to the SQL server based on user inputs.
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.
- Microsoft Teams is installed and you have an account
- .NET Core SDK version 3.1
- ngrok or equivalent tunnelling solution
##To Try
-
If you are using Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Select
TeamsConversationBot.csproj
file
-
For running locally - Run ngrok - point to port 3978
ngrok http -host-header=rewrite 3978
-
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
- Use the current
-
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.) -
This step is specific to Teams.
- Edit the
manifest.json
contained in theteamsAppManifest
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 themanifest.json
) - Zip up the contents of the
teamsAppManifest
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the Apps view click "Upload a custom app")
- Edit the
-
Run your bot, either from Visual Studio with
F5
or usingdotnet run
in the appropriate folder.
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.
- Hi
- Result: The bot will send the welcome card for you to interact with, provde you a list of all possible commands that bot understands
- Add me to DNS team
- Result: The bot will respond to the message if user was succesfully added or not. In case of success - the response is "Sucessfully registered you to team DNS" In case of failure - the response is "Please enter valid team name from list"
- get my total, get team total, get rank, get overall team stats, get team stats for today
- Result: The bot will send a 1-on-1 message to each member in the current conversation based on the query after fetching aggregarted data from SQL server
You can select an option from the command list by typing @TeamsConversationBot
into the compose message area and What can I do?
text above the compose area.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.
-
How Microsoft Teams bots work This is the doc I followed https://docs.microsoft.com/en-us/microsoftteams/platform/bots/how-to/create-a-bot-for-teams
And picked skeleton source code form https://github.com/microsoft/BotBuilder-Samples/tree/main/samples/csharp_dotnetcore/57.teams-conversation-bot