csharp

page_type	sample
description	Demonstrating the feature where user can send suggested actions using bot.
products	office-teams office office-365
languages	csharp
extensions	contentType createdDate samples 04/27/2022 12:00:00 AM
urlFragment	officedev-microsoft-teams-samples-bot-suggested-actions-csharp

Send Suggested Actions

This sample shows the feature where user can send suggested actions using bot.

Included Features

• Bots
• Suggested Actions

Interaction with app

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 manifest (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Send Suggested Actions: Manifest

Prerequisites

• 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 Microsoft Teams is installed and you have an account

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
   
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 (sideloading), 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

1. Register a new application in the Microsoft Entra ID – App Registrations portal.

2. Setup for Bot

   • Register a Microsoft Entra ID aap registration in Azure portal.
   • Also, register a bot with Azure Bot Service, following the instructions here.
   • Ensure that you've enabled the Teams Channel
   • While registering the bot, use https://<your_tunnel_domain>/api/messages as the messaging endpoint.

   NOTE: When you create your app registration, you will create an App ID and App password - make sure you keep these for later.

3. Setup NGROK

• 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

4. Setup for code

• Clone the repository

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

• Modify the /appsettings.json and fill in the following details:

  • {{MicrosoftAppId}} - Generated from Step 1 is the application app id
  • {{MicrosoftAppPassword}} - Generated from Step 1, also referred to as Client secret

• In a terminal, navigate to samples/bot-suggested-actions/csharp

  change into project folder

  cd # SuggestedActions

• From a terminal

  # run the bot
  dotnet run

• Or from Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to SuggestedActions folder
  • Select SuggestedActionsBot.csproj file
  • Press F5 to run the project

5. Setup Manifest for Teams

• 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 app registration earlier) everywhere you see the place holder string {{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 and replace {{domain-name}} with base Url of your 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 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 the Apps view click "Upload a custom app")

  • Go to Microsoft Teams. From the lower left corner, select Apps
  • From the lower left corner, choose Upload a custom App
  • Go to your project directory, the ./appPackage folder, select the zip folder, and choose Open.
  • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

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

Running the sample

Action.Compose will @metion the user configured in the action in this case the its bot named Facilitator

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

• Send suggested actions
• Bot Framework Documentation
• Bot Basics
• Azure Bot Service Introduction
• Azure Bot Service Documentation