csharp

page_type	sample
description	This sample app demonstrate the Conversation Bot using Bot Framework v4
products	office-teams office office-365
languages	csharp
extensions	contentType createdDate samples 10/17/2019 13:38:25 PM
urlFragment	officedev-microsoft-teams-samples-bot-conversation-csharp

Teams Conversation Bot

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.

• Interaction with bot

Prerequisites

• Microsoft Teams is installed and you have an account
• .NET SDK version 6.0
• ngrok or equivalent tunnelling solution

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 --host-header=rewrite 3978

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

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 TeamsAppManifest 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 with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok.io then your domain-name will be 1234.ngrok.io.
   • Zip up the contents of the TeamsAppManifest folder to create a manifest.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 personal/team/groupChat scope (Supported scopes)

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:

Added bot UI:

Show Welcome command interaction:

• Group Chat Scope Interactions:

Adding bot UI:

Added bot UI:

Show Welcome command interaction:

• Team Scope Interactions:

Adding bot UI:

Added bot UI:

Show Welcome command interaction:

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

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

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

• How Microsoft Teams bots work