Skip to content

Latest commit

 

History

History
 
 

nodejs

Readme.md

page_type description products languages extensions urlFragment
sample
Get real time meeting events
office-teams
office
office-365
nodejs
contentType createdDate
samples
10/11/2021 17:35:46 PM
officedev-microsoft-teams-samples-meetings-events-nodejs

Realtime meeting events

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.

Interaction with app

Meetings EventsGif

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

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

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

  1. Setup NGROK

    • Run ngrok - point to port 3978
    ngrok http -host-header=localhost 3978

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

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

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

    • <<App-ID>> with your AAD app registration id

    • <<VALID DOMAIN>> with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok.io then your domain-name will be 1234.ngrok.io.

    • Zip up the contents of the appPackage 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 appPackage.

  • Install the App in Teams Meeting

Running the sample

MeetingEvents command interaction:

Meeting start event

End meeting events details:

Meeting end event

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