Share via

Teams Conversation Bot

Browse code

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.

Included Features

  • Bots
  • Adaptive Cards
  • Teams Conversation Events
  • Immersive Reading Support for Cards

Interaction with bot

Conversation Bot

Try it yourself - experience the App in your Microsoft Teams client

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. (Uploading must be enabled for your tenant, see steps here).

Teams Conversation Bot: Manifest

Prerequisites

Run the app (Using Microsoft 365 Agents Toolkit for Visual Studio)

The simplest way to run this sample in Teams is to use Microsoft 365 Agents Toolkit for Visual Studio.

  1. Install Visual Studio 2022 Version 17.14 or higher Visual Studio
  2. Install Microsoft 365 Agents Toolkit for Visual Studio Microsoft 365 Agents Toolkit extension
  3. 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.
  4. Right-click the 'M365Agent' project in Solution Explorer and select Microsoft 365 Agents Toolkit > Select Microsoft 365 Account
  5. Sign in to Microsoft 365 Agents Toolkit with a Microsoft 365 work or school account
  6. Set Startup Item as Microsoft Teams (browser).
  7. Press F5, or select Debug > Start Debugging menu in Visual Studio to start your app
    image
  8. In the opened web browser, select Add button to install the app in Teams

If you do not have permission to upload custom apps (uploading), Microsoft 365 Agents 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.

Setup

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.

  1. 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

  2. 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

  3. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  4. If you are using Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples/bot-conversation/csharp folder
    • Select TeamsConversationBot.csproj or TeamsConversationBot.slnfile

  5. 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)

  6. Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.

  7. This step is specific to Teams.

    • Edit the manifest.json contained in the appPackage 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 the manifest.json)
    • Edit the manifest.json for validDomains, replace <<domain-name>> with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.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 a appPackage.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)

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Running the sample

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.

  1. 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:

Adding bot UI: personal-AddBot

Added bot UI: personal-AddedBot

Show Welcome command interaction: personal-WelcomeCard-Interaction

  • Group Chat Scope Interactions:

Adding bot UI: groupChat-AddBot

Added bot UI: groupChat-AddedBot

Show Welcome command interaction: groupChat-BotCommands-interactions

  • Team Scope Interactions:

Adding bot UI: team-AddBot

Added bot UI: team-AddedBot

Show Welcome command interaction: team-WelcomeCommand-Card

  1. 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: personal-MentionMeCommand

  • Group Chat Scope Interactions:

MentionMe command interaction: groupChat-BotCommands-interactions

  • Team Scope Interactions:

MentionMe command interaction: team-MentionCommand-Interaction

  1. 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: personal-MessageAllMembersCommand

  • Group Chat Scope Interactions:

MessageAllMembers command interaction: groupChat-MessageAllMembers-interaction

  • Team Scope Interactions:

MessageAllMembers command interaction: team-MessageAllMembers-interactions

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 using Reset read count command

  • Valid Scopes: personal, group chat, team chat

  • Group Chat Scope Interactions: Check Read count command interaction: groupChat-CheckReadCount-interaction

Reset Read count command interaction: groupChat-ResetReadCount-interaction

  1. 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. immersive-reader-card

  • A new screen will be open and the text will be read by default which is mentioned inside the speak property of adaptive card. immersive-reader-screen

  1. Message update events for user messages

  • You will recieve event updates for message edit/delete features.

  • Message is edited message-edit

  • Message is soft-deleted message-soft-delete

  • Message is restored message-undelete

  • AI label - enables user to identify that the message was generated using AI. AI-label

  • Citations - enables user to refer to the source of the bot's message through in-text citations and the reference. Citations

  • Feedback buttons - enables user to provide positive or negative feedback based on their experience. Feedback-buttons

Feedback-buttons1

Feedback-buttons2

Feedback-buttons3

  • Sensitivity label - enables user to understand the confidentiality of the bot's message. Sensitivity-label

  • Send AI message - Replies back with a bot message containing all formats: AI label, Citations, Feedback buttons, and Sensitivity label. sendtext

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.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading