Skip to content

Latest commit

 

History

History
 
 

csharp

README.md

page_type description products languages extensions urlFragment
sample
This Teams bot enables configuration and reconfiguration with dynamic search capabilities on Adaptive Cards.
office-teams
office
office-365
csharp
contentType createdDate
samples
11/03/2024 01:38:25 PM
officedev-microsoft-teams-samples-bot-configuration-app-auth-csharp

Teams App Localization

This sample illustrates bot configuration and reconfiguration in Teams and group chats, showcasing a type-ahead search feature on Adaptive Cards. It supports both static and dynamic search options, enabling a customizable and interactive bot experience for users.

Included Features

  • Bots
  • Adaptive Cards
  • bot reconfiguration
  • Type ahead search

Interaction with app

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

Bot Configuration: Manifest

Prerequisites

Verify you have the right account for building Teams apps and install some recommended development tools.

Run the app (Using Teams Toolkit for Visual Studio)

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

  1. Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
  2. Install Teams Toolkit for Visual Studio Teams 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. In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
  5. In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
  6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
  7. Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
  8. 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.

Setup

  1. Register a new application in the Azure Active Directory – App Registrations portal.

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

  2. Setup for Bot

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

  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
  1. 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 while doing AAd app registration in Azure portal.

  • {{ClientSecret}} - Generated from Step 1, also referred to as Client secret

  • Run the bot from a terminal or from Visual Studio:

  1. If you are using Visual Studio
  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to Bot configuration\csharp folder
  • Select Bot Configuration.csproj file
  1. This step is related to Microsoft Teams app manifest
    • Edit the manifest.json contained in the appPackage or AppManifest_Hub folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string {{Microsoft-App-Id}}
    • 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 Manifest or Manifest_hub folder to create a manifest.zip
    • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
    • Add the app to team/groupChat scope (Supported scopes)

Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the manifest.json in the /AppManifest_Hub folder with the required values.

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.

Configurable Card A configurable card is used to modify data even after the bot has been installed. When the bot is added to a Teams or group chat scope, it utilizes 'config/fetch' and 'config/submit' invoke requests.

  • Result: The bot will send the configurable adaptive card

  • Valid Scopes: group chat, team chat

  • Bot Interactions:

    Adding bot UI: groupChat-AddBot

Added bot UI: groupChat-AddedBot

Auth card Interactions:

  • Note: The Sign-in page displayed is currently using a dummy URL. Please update it with your authentication URL.

Bot-description-card

Deploy to Azure

Deploy your project to Azure by following these steps:

From Visual Studio Code From TeamsFx CLI
  • Open Teams Toolkit, and sign into Azure by clicking the Sign in to Azure under the ACCOUNTS section from sidebar.
  • After you signed in, select a subscription under your account.
  • Open the Teams Toolkit and click Provision from DEPLOYMENT section or open the command palette and select: Teams: Provision.
  • Open the Teams Toolkit and click Deploy or open the command palette and select: Teams: Deploy.
  • Run command teamsfx account login azure.
  • Run command teamsfx provision --env dev.
  • Run command: teamsfx deploy --env dev.

Note: Provisioning and deployment may incur charges to your Azure Subscription.

Further reading