nodejs

page_type	sample
description	This Node.js sample demonstrates how a bot can receive real-time meeting events within Microsoft Teams, enhancing meeting interactivity.
products	office-teams office office-365
languages	nodejs
extensions	contentType createdDate samples 10/11/2021 17:35:46 PM
urlFragment	officedev-microsoft-teams-samples-meetings-events-nodejs

Realtime meeting events

Experience real-time meeting and participant events with this C# bot sample for Microsoft Teams. Currently available in public developer preview, it supports Adaptive Cards, bot interactions, and RSC permissions, allowing seamless integration for enhanced meeting management. To try it out, simply upload the provided manifest in your Teams client.

Using this Node JS sample, a bot can receive real-time meeting events. For reference please check Real-time Teams meeting events

This feature shown in this sample is currently available in public developer preview only.

Included Features

• Bots
• Adaptive Cards
• RSC Permissions

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

Realtime meeting events: Manifest

Prerequisites

1. Office 365 tenant. You can get a free tenant for development use by signing up for the Office 365 Developer Program.

2. To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher).

   # determine node version
   node --version

3. dev tunnel or ngrok latest version or Tunnel Relay

   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.

4. Microsoft 365 Agents Toolkit for VS Code or TeamsFx CLI

Run the app (Using Microsoft 365 Agents Toolkit for Visual Studio Code)

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

1. Ensure you have downloaded and installed Visual Studio Code
2. Install the Microsoft 365 Agents Toolkit extension
3. Select File > Open Folder in VS Code and choose this samples directory from the repo
4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
6. 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 (uploading), 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

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.

1. Setup for Bot

• 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 bot you will create an App ID and App password - make sure you keep these for later.

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

3. App Registration

Register your application with Azure AD

1. Register a new application in the Microsoft Entra ID – App Registrations portal.
2. Select New Registration and on the register an application page, set following values:
   • Set name to your app name.
   • Choose the supported account types (any account type will work)
   • Leave Redirect URI empty.
   • Choose Register.
3. On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You'll need those later when updating your Teams application manifest and in the appsettings.json.
4. Navigate to API Permissions, and make sure to add the follow permissions:
   • Select Add a permission
   • Select Microsoft Graph -> Delegated permissions.
   • User.Read (enabled by default)
   • Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

4. Setup for code

• Clone the repository

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

• In a console, navigate to samples/meeting-events/nodejs

• Install modules

  npm install

• Navigate to samples/meeting-events/nodejs and update the .env configuration for the bot to use the MicrosoftAppId (Microsoft App Id) and MicrosoftAppPassword (App Password) from the app registration in your Azure portal or from Bot Framework registration.

NOTE: the App Password is referred to as the client secret in the azure portal and you can always create a new client secret anytime.

• Run your bot at the command line:

  npm start

• Install modules & Run the NodeJS Server

  • Server will run on PORT: 3978
  • Open a terminal and navigate to project root directory

  npm run server

• This command is equivalent to: npm install > npm start

5. Setup Manifest for Teams (This step is specific to Teams.)

• Modify the manifest.json in the /appManifest folder and replace the following details

  • <<App-ID>> with your Microsoft Entra ID app registration id

  • <<VALID DOMAIN>> with base Url 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

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

• Install the App in Teams Meeting

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

Running the sample

MeetingEvents command interaction:

End meeting events details:

MeetingParticipantEvents command interaction:

To utilize this feature, please enable Meeting event subscriptions for Participant Join and Participant Leave in your bot, following the guidance outlined in the meeting participant events documentation

End meeting events details:

Interacting with the bot in Teams

Once the meeting where the bot is added starts or ends, real-time updates are posted in the chat.

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

• Real-time Teams meeting events
• Meeting apps APIs
• Real-time Teams meeting participant events