Skip to content

Latest commit

 

History

History
 
 

nodejs

Readme.md

page_type description products languages extensions urlFragment
sample
This sample shows a feature where user can broadcast a message to all members of organization using activty feed notification through teams tab.
office-teams
office
office-365
nodejs
contentType createdDate
samples
01/25/2022 12:00:00 AM
officedev-microsoft-teams-samples-graph-activity-feed-broadcast-nodejs

Broadcast message to organization using activity feed notification (Graph APIs)

This sample shows a feature where user can broadcast a message to all members of organization using activty feed notification through teams tab.

Included Features

  • Teams SSO (tabs)
  • Activity Feed Notifications
  • Graph API

Interaction with app

activity-feed-app

Prerequisites

  • Microsoft Teams is installed and you have an account (not a guest account)
  • NodeJS
  • ngrok or equivalent tunnelling solution
  • M365 developer account or access to a Teams account with the appropriate permissions to install an app.

Setup

1. Setup for App Registration

  1. Register a new application in the Azure Active Directory – 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. Under Manage, select Expose an API.
  5. Select the Set link to generate the Application ID URI in the form of api://{AppID}. Insert your fully qualified domain name (with a forward slash "/" appended to the end) between the double forward slashes and the GUID. The entire ID should have the form of: api://fully-qualified-domain-name/{AppID}
    • ex: api://%ngrokDomain%.ngrok-free.app/00000000-0000-0000-0000-000000000000.
  6. Select the Add a scope button. In the panel that opens, enter access_as_user as the Scope name.
  7. Set Who can consent? to Admins and users
  8. Fill in the fields for configuring the admin and user consent prompts with values that are appropriate for the access_as_user scope:
    • Admin consent title: Teams can access the user’s profile.
    • Admin consent description: Allows Teams to call the app’s web APIs as the current user.
    • User consent title: Teams can access the user profile and make requests on the user's behalf.
    • User consent description: Enable Teams to call this app’s APIs with the same rights as the user.
  9. Ensure that State is set to Enabled
  10. Select Add scope
    • The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with /access_as_user appended to the end:
      • `api://[ngrokDomain].ngrok-free.app/00000000-0000-0000-0000-000000000000/access_as_user.
  11. In the Authorized client applications section, identify the applications that you want to authorize for your app’s web application. Each of the following IDs needs to be entered:
    • 1fec8e78-bce4-4aaf-ab1b-5451cc387264 (Teams mobile/desktop application)
    • 5e3ce6c0-2b1f-4285-8d4b-75ee78787346 (Teams web application)
  12. 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)
    • ChannelMessage.Send
    • ChatMessage.Send
    • Chat.ReadWrite
    • TeamsActivity.Send
    • TeamsAppInstallation.ReadForUser.

  • You need to add TeamsActivity.Send and Directory.Read.All as Application level permissions

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

  1. Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app. Set a redirect URI:

    • Select Add a platform.
    • Select web.
    • Enter the redirect URI for the app in the following format: https://{Base_Url_Domain}/auth-end. This will be the page where a successful implicit grant flow will redirect the user. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your {Base_Url_Domain} will be1234.ngrok-free.app.

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

2. Setup NGROK

  1. Run ngrok - point to port 3978
# ngrok http 3978 --host-header="localhost:3978"

3. Setup for code

  1. Clone the repository

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

  2. In the folder where repository is cloned navigate to samples/graph-activity-feed-broadcast/nodejs

  3. 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 in Visual studio code terminal by opening the project in Visual studio code

    npm install

    If you face any dependency error while installing node modules, try using below command

    npm install --legacy-peer-deps

  4. Update the .env configuration with the ClientId (MicrosoftAppId), ClientSecret(MicrosoftAppPassword) and TenantId generated in step 1 while doing App Registration.

  5. Run your bot at the command line:

    npm start

4. Setup Manifest for Teams

  1. This step is specific to Teams.
    • Edit the manifest.json contained in the appPackage folder to replace your Microsoft App Id (that was created when you registered your app earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Edit the manifest.json for contentUrl, websiteUrl inside staticTabs . Replace <<Domain-name>> 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.
    • Edit the manifest.json for validDomains 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.
    • Zip up the contents of the appPackage 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 Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
    • Add the app to personal/team/groupChat scope (Supported scopes)

Running the sample

  • Install TabActivityFeed manifest in Teams
  • Add Tab in Personal scope
  • Fill the Details in Page and click on Send notification button
  • Notification triggred by Tab App will appear in Teams Activity Feed for all users.

Personal Scope broadcast-tab broadcast-notification

Further reading