Skip to content

Latest commit

 

History

History
 
 

nodejs

README.md

page_type description products languages extensions urlFragment
sample
This is a sample application which demonstrates the use of online meeting subscription and sends you the notifications in chat using bot.
office-teams
office
office-365
nodejs
contentType createdDate
samples
09/24/2022 12:00:00 AM
officedev-microsoft-teams-samples-graph-meeting-notification-nodejs

Online meeting subscription

This is a sample application which demonstrates use of online meeting subscription that will post notifications when user joined/left and when meeting start/end.

Concepts introduced in this sample

  • After sucessfully installation of bot in meeting you will get a welcome card and the subscription will be created for meeting it is installed in.

Welcome Card

Prerequisites

  • Microsoft Teams is installed and you have an account

  • Node.js version 10.14 or higher

    #determine node version
node --version

  • ngrok or equivalent tunnelling solution

Register your application with Azure AD

  1. Register a new application in the Azure Active Directory – App Registrations portal.
  2. 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.
  3. Navigate to API Permissions, and make sure to add the follow permissions:

  • Select Add a permission

  • Select Microsoft Graph -> Application permissions.

  • OnlineMeetings.Read.All

  • Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

  1. Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the appsettings.json file.

Create Azure bot resource

In Azure portal, create a Azure Bot resource.

  • Ensure that you've enabled the Teams Channel

  • In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running ngrok. Append with the path /api/messages

Create and install Self-Signed certificate

To include resource data of graph notifications, this Graph API require self-signed certificate. Follow the below steps to create and manage certificate.

  1. You can self-sign the certificate, since Microsoft Graph does not verify the certificate issuer, and uses the public key for only encryption.

  2. Use Azure Key Vault as the solution to create, rotate, and securely manage certificates. Make sure the keys satisfy the following criteria:

    • The key must be of type RSA
    • The key size must be between 2048 and 4096 bits

  3. Follow this documentation for the steps - Create and install Self-Signed certificate

Setup code.

  1. Clone the repository

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

  • Launch Visual Studio code

  • File -> Open Folder

  • Navigate to samples/graph-change-notification-team-channel/nodejs folder.

  • Update the .env file

Update configuration with the MicrosoftAppId, MicrosoftAppPassword, MicrosoftAppTenantId, Base64EncodedCertificate, EncryptionCertificateId, PRIVATE_KEY_PATH

Instruction for .env

  1. Provide MicrosoftAppId, MicrosoftAppPassword and MicrosoftAppTenantId in the .env that is created in Azure.
  2. Provide the ngrok url as BaseUrl in appsetting on which application is running on.
  3. You should be having Base64EncodedCertificate from Create and install Self-Signed certificate step.
  4. Use Certificate "PEM" format and add the certificate name for PRIVATE_KEY_PATH For eg PRIVATE_KEY_PATH=PrivateKeyFileName.pem" in .env file. Also make sure the private key file is stored inside helper folder of this project.

  • Install node modules

    Inside node js folder, open your local terminal and run the below command to install node modules. You can do the same for client folder by opening the project in Visual Studio code.

    npm install

  • Run your app

      npm start

  • Run ngrok - point to port 3978

      ngrok http -host-header=rewrite 3978

Instruction for manifest

  1. Fill any GUID value in your manifest for . As an alternative, you can put your Microsoft App Id.
  2. Update placeholder with your Microsoft App Id.
  3. ZIP the manifest and make sure manifest.json and two icon images are at root.
  4. Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

Follow this documentation to get more information on custom apps and uploading them into Teams - Manage custom apps and Upload an app package

Further reading