page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This app demonstrates using bot conversation events in Microsoft Teams, supporting adaptive cards, read receipts, and message update events. It includes immersive reader support for enhanced accessibility. |
|
|
|
officedev-microsoft-teams-samples-bot-conversation-csharp |
This sample app demonstrates how to handle various bot conversation events in Microsoft Teams, including read receipts and adaptive card interactions. It showcases capabilities such as immersive reader support and message update tracking, making it ideal for personal, group, and team chat scopes.
Bot Framework v4 Conversation Bot sample for Teams (Messages in bot conversations).
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.
- Bots
- Adaptive Cards
- Teams Conversation Events
- Immersive Reading Support for Cards
Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).
Teams Conversation Bot: Manifest
- Microsoft Teams is installed and you have an account
- .NET SDK version 6.0
- dev tunnel or ngrok latest version or equivalent tunnelling solution
- Teams Toolkit for Visual Studio
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.
- Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
- Install Teams Toolkit for Visual Studio Teams Toolkit extension
- In the debug dropdown menu of Visual Studio, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel.
- In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
- In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
- Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
- In the browser that launches, select the Add button to install the app to Teams.
If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.
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 3978 --host-header="localhost:3978"
Alternatively, you can also use the
dev tunnels
. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:devtunnel host -p 3978 --allow-anonymous
-
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 Microsoft Entra ID 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 the tunneling application. 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-conversation/csharp
folder - Select
TeamsConversationBot.csproj
orTeamsConversationBot.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.)- Also, set MicrosoftAppType in the
appsettings.json
. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)
- Also, 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 theappPackage
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
, replace<<domain-name>>
with base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.ngrok-free.app
and if you are using dev tunnels then your domain will be like:12345.devtunnels.ms
. - Zip up the contents of the
appPackage
folder to create aappPackage.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package) - Upload the
appPackage.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 personal/team/groupChat scope (Supported scopes)
- Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
You can interact with this bot in Teams by sending it a message, or selecting a command from the command list. The bot will respond to the following strings.
- Show Welcome
-
Result: The bot will send the welcome card for you to interact with
-
Valid Scopes: personal, group chat, team chat
-
Personal Scope Interactions:
Show Welcome command interaction:
- Group Chat Scope Interactions:
Show Welcome command interaction:
- Team Scope Interactions:
Show Welcome command interaction:
- MentionMe
-
Result: The bot will respond to the message and mention the user
-
Valid Scopes: personal, group chat, team chat
-
Personal Scope Interactions:
MentionMe command interaction:
- Group Chat Scope Interactions:
MentionMe command interaction:
- Team Scope Interactions:
MentionMe command interaction:
- MessageAllMembers
-
Result: The bot will send a 1-on-1 message to each member in the current conversation (aka on the conversation's roster).
-
Valid Scopes: personal, group chat, team chat
-
Personal Scope Interactions:
MessageAllMembers command interaction:
- Group Chat Scope Interactions:
MessageAllMembers command interaction:
- Team Scope Interactions:
MessageAllMembers command interaction:
4.Read Receipt Check Read count
-
Result: The bot will check the count of members who have read your message which sent through
MessageAllMembers
. User can also reset the count usingReset read count
command -
Valid Scopes: personal, group chat, team chat
-
Group Chat Scope Interactions: Check Read count command interaction:
Reset Read count command interaction:
- ImmersiveReader
-
You can use the immersive reader property of adaptive cards by using the speak property.
immersivereader
command will send an adpative card in teams chat. -
A new screen will be open and the text will be read by default which is mentioned inside the speak property of adaptive card.
- Message update events for user messages
-
You will recieve event updates for message edit/delete features.
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.