Bot Framework v4 Conversation Bot sample for Teams.
This bot has been created using Bot Framework. This sample shows how to create a new conversation thread in a channel in Microsoft Teams. It is important to note the use of the channelId
- you can get the list of channels in a team to get this .
- Microsoft Teams is installed and you have an account
- .NET Core SDK version 3.1
- 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.
-
Clone the repository
git clone https://github.com/Microsoft/botbuilder-samples.git
-
If you are using Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
samples/csharp_dotnetcore/58.teams-start-new-thread-in-channel
folder - Select
TeamsStartNewThreadInTeam.csproj
file
-
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. 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.