Bot Framework v4 Conversation Bot sample 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.
This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.
- Java 1.8+
- Install Maven
- An account on Azure if you want to deploy to Azure.
- Microsoft Teams is installed and you have an account
- ngrok or equivalent tunnelling solution
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.
-
Run 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
resources/application.properties
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
-
From the root of this project folder:
- Build the sample using
mvn package
- Unless done previously, install the packages in the local cache by using
mvn install
- Run it by using
java -jar .\target\bot-teams-start-new-thread-sample.jar
- Build the sample using
Note this
manifest.json
specified that the bot will be installed in "personal", "team" and "groupchat" scope which is why you immediately entered a one on one chat conversation with the bot. You can at mention the bot in a group chat or in a Channel in the Team you installed it in. Please refer to Teams documentation for more details.
You can interact with this bot by sending it a message. The bot will respond by creating a new thread in the channel and replying to that new thread.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.