page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample app demonstrate how to start a thread in a specific Team's channel using Bot Framework v4 |
|
|
|
officedev-microsoft-teams-samples-bot-initiate-thread-in-channel-csharp |
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 SDK version 6.0
- 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 - point to port 3978
ngrok http --host-header=rewrite 3978
-
Setup for Bot
In Azure portal, create a Azure Bot resource.
- For bot handle, make up a name.
- Select "Use existing app registration" (Create the app registration in Azure Active Directory beforehand.)
- If you don't have an Azure account create an Azure free account here
In the new Azure Bot resource in the Portal,
- Ensure that you've enabled the Teams Channel
- In Settings/Configuration/Messaging endpoint, enter the current
https
URL you were given by running ngrok. Append with the path/api/messages
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
If you are using Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
samples/bot-initiate-thread-in-channel/csharp
folder - Select
TeamsStartNewThreadInTeam.csproj
orTeamsStartNewThreadInTeam.sln
file
-
Update the
appsettings.json
configuration for the bot to use the MicrosoftAppId, MicrosoftAppPassword, MicrosoftAppTenantId generated in Step 2 (App Registration creation). (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.)- Set "MicrosoftAppType" in the
appsettings.json
. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)
- Set "MicrosoftAppType" in the
-
Run your bot, either from Visual Studio with
F5
or usingdotnet run
in the appropriate folder. -
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
) - Edit the
manifest.json
forvalidDomains
with base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok.io
then your domain-name will be1234.ngrok.io
. - Zip up the contents of the
TeamsAppManifest
folder to create amanifest.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package) - Upload the
manifest.zip
to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.) - Add the app to a any Teams channel
- Edit the
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.
Adding the bot to a team's channel :
Mention the bot in a team's channel using "@" with any message like: '@yourbotname Hello' :
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.