57.teams-conversation-bot

TeamsConversationBot

Bot Framework v4 echo bot sample for Teams.

This bot has been created using Bot Framework, it shows how to create a simple bot that accepts input from the user and echoes it back.

Prerequisites

• .NET Core SDK version 2.1

  # determine dotnet version
  dotnet --version

• Microsoft Teams is installed and you have an account

To try this sample

Ngrok

• Download and install ngrok
• In terminal navigate to where ngrok is installed and run:

ngrok http -host-header=rewrite 3978

• Copy/paste the https web address into notepad as you will need it later

Microsoft Teams Setup

• Launch Microsoft Teams. In the search bar at the top of Teams search for and select App Studio.
• Click the Manifest editor tab near the top of the screen.
• Click the Create a new app button on the left hand side.
• Under the Details section fill in the following fields
  • In the Short name field enter EchoBot
  • Click the Generate button under App ID
  • Package Name
  • Version
  • Short description
  • Long description
  • Developer name
  • Website
  • Privacy statement web address
  • Terms of use web address
• Under the Capabilities tab on the left hand side click the Bots tab
• Click the Set up button
• Under the New bot tab Fill in the following fields
  • Put TeamsConversationBot into the Name field
  • Under Scope check all 3 boxes Personal, Team, Group Chat
  • Click the Create bot button
• Copy the Bot ID (string under TeamsConversationBot) and paste it into notepad as you will need it later
• Click the Generate new password button (copy/paste) the password into notepad as you will need it later)
• Under Messaging endpoint paste the https ngrok url and add /api/messages to the end
  • EX: https://ca7f8a7e.ngrok.io/api/messages
• Press Enter to save the address

Bot Setup

• Clone the repository

  git clone https://github.com/Microsoft/botbuilder-samples.git

• In Visual Studio navigate to the 5NNNNNNNNN.teams-conversation-bot folder and open the appsettings.json file

• Put the you saved earlier from Teams in the MicrosoftAppId field

• Put the password into the MicrosoftAppPassword field

• Save

• Run the bot from a terminal or from Visual Studio, choose option A or B.

  A) From a terminal

  # run the bot
  dotnet run

  B) Or from Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to samples/csharp_dotnetcore/5NNNNNNNNN.teams-echo-bot folder
  • Select TeamsConversationBot.csproj file
  • Press F5 to run the project

Finishing Teams Setup

• Back in Teams click Test and distribute on the left hand side under Finish section
• Click the Install button

To install bot in a personal chat...	To install in a group chat...	To install in team chat...
1. Click Add button	1. Click the down arrow to the right of the Add button 2. Click Add to Chat 3. Search for and select your group chat 4. Click the Set up bot button Note: There must be at least 1 message in a group chat for it to be searchable	1. Click the down arrow to the right of the Add button 2. Click Add to Team 3. Search for and select your team 4. Click the Set up a bot button

Interacting with the bot

You can interact with this bot 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

2. MentionMe

• Result: The bot will respond to the message and mention the user
• Valid Scopes: personal, group chat, team chat

3. MessageAllMembers

• Result: The bot will send a 1-on-1 message to each memeber in the current conversation (aka on the converstation's roster).
• Valid Scopes: personal, group chat, team chat

You can select an option from the coammn list by typing @TeamsConversationBot into the compose message area and What can I do? text above the compose area.