Skip to content

Latest commit

 

History

History
 
 

nodejs

README.md

page_type description urlFragment products languages extensions
sample
This sample app demonstrates sending change notifications to user presence in Teams based on user presence status. The notifications are sent to user through bot in teams.
officedev-microsoft-teams-samples-graph-change-notification-nodejs
office-teams
office
office-365
nodejs
contentType createdDate
samples
07/07/2021 01:38:26 PM

Change Notification sample using nodejs

Bot Framework v4 ChangeNotification sample.

This sample app demonstrates sending notifications to users when presence status is changed.

Included Features

  • Bots
  • Graph API
  • Change Notifications

Interaction with app

PreviewImage

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio Code)

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

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams 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 (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.

    • Your app must be registered in the Azure AD portal to integrate with the Microsoft identity platform and call Microsoft Graph APIs. See Register an application with the Microsoft identity platform.

    • You need to add following permissions mentioned in the below screenshots to call respective Graph API

      Instruction on setting connection string for bot authentication on the behalf of user

      • In the Azure portal, select your resource group from the dashboard.

      • Select your bot channel registration link.

      • Open the resource page and select Configuration under Settings.

      • Select Add OAuth Connection Settings.

        image

      • Complete the form as follows.

      a. Enter a name for the connection. You'll use this name in your bot in the appsettings.json file. For example BotTeamsAuthADv1.

      b. Service Provider. Select Microsoft Entra ID. Once you select this, the Azure AD-specific fields will be displayed.

      c. Client id. Enter the Application (client) ID that you recorded for your Azure identity provider app in the steps above.

      d. Client secret. Enter the secret that you recorded for your Azure identity provider app in the steps above.

      e. Grant Type. Enter authorization_code.

      f. Login URL. Enter https://login.microsoftonline.com.

      g. Tenant ID, enter the Directory (tenant) ID that you recorded earlier for your Azure identity app or common depending on the supported account type selected when you created the identity provider app. h. For Resource URL, enter https://graph.microsoft.com/ i. Provide Scopes like "Presence.Read, Presence.Read.All"

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

  • Update the .env configuration for the bot to use the MicrosoftAppId and MicrosoftAppPassword,connectionName and notificationUrl (Note the MicrosoftAppId is the AppId created in step 1 (Setup for Bot), the MicrosoftAppPassword is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.) and connectionName we can get from step "Select your bot channel registration link." and for the notificationUrl eg.1234.ngrok-free.app/api/notifications

  • Open from Visual Studio code

    • Launch Visual Studio code
    • File -> Open Folder
    • Navigate to samples/graph-change-notification/nodejs folder
    • Run npm command in the terminal 
      npm install
    • Press F5 to run the project
  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.

Running with sample

  • After sucessfully installation of app you will get a sign in button. When sign in is complete then you get your current status in adapative card

image

image

  • After that when the user status chagnes you will get notify about their status:
  • Change user status from available to busy like

image

  • Change user status from busy to busy offline

image

Further reading