page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample application demonstrates how to implement targeted in-meeting notifications in Microsoft Teams using adaptive cards and bot interactions. |
|
|
|
officedev-microsoft-teams-samples-meetings-notification-nodejs |
This sample application illustrates how to implement Targeted In-Meeting Notification within Microsoft Teams. By utilizing adaptive cards and bot interactions, it enables users to send and receive notifications, view meeting agendas, and provide feedback, fostering a more interactive and efficient meeting experience.
- Bots
- In-Meeting Notifications
- Adaptive Cards
- RSC Permissions
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).
Meetings Content Bubble: Manifest
-
To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher).
# determine node version node --version
-
Office 365 tenant. You can get a free tenant for development use by signing up for the Office 365 Developer Program.
-
dev tunnel or ngrok latest version or equivalent tunnelling solution
-
If you are using Ngrok to test locally, you'll need Ngrok installed on your development machine. Make sure you've downloaded and installed Ngrok on your local machine. ngrok will tunnel requests from the Internet to your local computer and terminate the SSL connection from Teams.
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
- Select Debug > Start Debugging or F5 to run the app in a Teams web client.
- 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.
NOTE: The free ngrok plan will generate a new URL every time you run it, which requires you to update your Azure AD registration, the Teams app manifest, and the project configuration. A paid account with a permanent ngrok URL is recommended.
- Setup for Bot
-
Register Azure AD application resource in Azure portal
-
In Azure portal, create a Azure Bot resource.
-
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 in Azure portal, you will create an App ID and App password - make sure you keep these for later.
- 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
- Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In a terminal, navigate to
samples\meetings-notification\nodejs
cd samples/meetings-notification/nodejs
-
Install modules
npm install
-
Go to .env file in your project folder and update
MicrosoftAppId
,MicrosoftAppPassword
with the values received from your Microsoft Entra ID app registration.- Update
BaseUrl
as per your domain like ngrok url: https://1234.ngrok-free.app
- Update
-
Start the bot
npm start
- Setup Manifest for Teams
- Modify the
manifest.json
file placed in/appManifest
folder and replace the <<APP_ID>> with your Microsoft App Id received via doing Microsoft Entra ID app registration in your Azure Portal.- Edit the
manifest.json
forvalidDomains
and replace <> with base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.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 amanifest.zip
-
- Upload the
manifest.zip
to Teams- Select Apps from the left panel.
- Then select Upload a custom app from the lower right corner.
- Then select the
manifest.zip
file fromappManifest
. - Install the App in Teams Meeting
- Upload the
- Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
Type SendContentBubble
in bot chat to send In-Meeting notifications.
Hello command interaction:
Provide your feedback:
Provide your feedback Yes:
Type SendTargetedNotification
in bot chat to send Targeted Meeting notifications.
Interacting with the app in Teams Meeting
Message the Bot by @ mentioning to interact with the content bubble.
- You will see agenda items listed in an Adaptive Card.
- Select any option and click on Push Agenda button
- You can submit your feedback on either Content Bubble/Adaptive card sent in chat.