Skip to content

Latest commit

 

History

History

csharp

README.md

page_type description products languages extensions urlFragment
sample
This sample application demonstrates how to implement in-meeting and targeted notifications within Microsoft Teams meetings using adaptive cards and bot interactions.
office-teams
office
office-365
csharp
contentType createdDate
samples
07/07/2021 01:38:26 PM
officedev-microsoft-teams-samples-meetings-notification-csharp

Meetings Notification

This sample illustrates how to implement In-Meeting Notification and Targeted In-Meeting Notification for scheduled meetings. By leveraging adaptive cards and bot interactions, it allows users to view agendas and provide feedback, enhancing the overall meeting experience and ensuring effective communication.

Included Features

  • Bots
  • In-Meeting Notifications
  • Targeted In-Meeting Notifications
  • Adaptive Cards
  • RSC Permissions

Interaction with app

Meetings Notification

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

Meetings Notification: Manifest

Prerequisites

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 Microsoft Entra ID – App Registrations portal.

  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.

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

    • {{MICROSOFT_APP_ID}} - Generated from Step 1 while doing Microsoft Entra ID app registration in Azure portal.
    • {{ MICROSOFT_APP_PASSWORD}} - Generated from Step 1, also referred to as Client secret
    • {{ BaseURL }} - Your application's base url. E.g. https://12345.ngrok-free.app if you are using ngrok and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.

  • If you are using Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples\meetings-notification\csharp folder
    • Select TargetedNotifications.sln file
  1. Setup Manifest for Teams

  • This step is specific to Teams.

    • Edit the manifest.json contained in the ./AppManifest 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 AppManifest 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 ./AppManifest 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.

Interacting with the app in Teams Meeting

Message the Bot by @ mentioning to interact with meetings notifications.

  1. You will see agenda items listed in an Adaptive Card.
  2. Select any option and click on Push Agenda button
  3. You can submit your feedback on either In-meeting notification/Adaptive card sent in chat.

Running the sample

Type SendInMeetingNotification in bot chat to send In-Meeting notifications.

Install

Welcome

Agenda card

Feedback submit

Feedback card

Send targeted meeting notification

Type SendTargetedNotification in bot chat to send Targeted Meeting notifications.

Meeting card

Target notification

Further Reading