nodejs

page_type	description	products	languages	extensions	urlFragment
sample	This bot can capture all channel messages in Teams using RSC permissions, without the need for @mentions.	office-teams office office-365	nodejs	contentType createdDate samples 06/10/2021 01:48:56 AM	officedev-microsoft-teams-samples-bot-receive-channel-messages-withRSC-nodejs

Receive Channel messages with RSC permissions

This sample app illustrates how a bot can capture all channel messages in Microsoft Teams by utilizing RSC (resource-specific consent) permissions, eliminating the need for @mentions. The bot supports adaptive card responses, easy local testing with tools like ngrok or dev tunnels, and deployment to Azure, allowing it to function effectively across different channels and group chats in Teams.

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. (Sideloading must be enabled for your tenant, see steps here).

Receive Channel messages with RSC permissions: 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 (For local environment testing) latest version (any other tunneling software can also be used)

   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. Teams Toolkit for VS Code or TeamsFx CLI

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

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

• Register a bot with Azure Bot Service, following the instructions here.

• 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 app registration in Azure portal, 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. Setup for code

• Clone the repository

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

• In the folder where repository is cloned navigate to samples/bot-receive-channel-messages-withRSC/nodejs

• 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

• Update the .env configuration for the bot to use the MicrosoftAppId (Microsoft App Id) and MicrosoftAppPassword (App Password) from the Microsoft Entra ID app registration in Azure portal or from Bot Framework registration.

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

• Run your app

  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

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

4. Run your app

   npm start

5. Setup Manifest for Teams

   • Edit the manifest.json contained in the appManifest folder to replace your Microsoft App Id (that was created when you registered your bot 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) <<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 and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms. Replace <> with any GUID or with your MicrosoftAppId/app id

   • Zip up the contents of the appManifest folder to create a manifest.zip

   • Sideload in a team to test

     • Select or create a team
     • Select the ellipses ... from the left pane. The drop-down menu appears.
     • Select Manage Team, then select Apps
     • Then select Upload a custom app from the lower right corner.
     • Then select the manifest.zip file from appManifest, and then select Add to add the bot to your selected team.

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

Running the sample

Adding bot UI:

Hey command interaction:

1 or 2 command interaction:

Adding App to group chat:

Group chat interaction with bot without being @mentioned:

Interacting with the bot in Teams

Select a channel and enter a message in the channel for your bot.

The bot receives the message without being @mentioned.

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

• Bot Framework Documentation
• Bot Basics
• Azure Bot Service Introduction
• Azure Bot Service Documentation
• Receive Channel messages with RSC