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. |
|
|
|
officedev-microsoft-teams-samples-bot-receive-channel-messages-withRSC-csharp |
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.
- Bots
- Adaptive Cards
- RSC Permissions
Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app manifest (.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
-
.NET Core SDK version 6.0
determine dotnet version
dotnet --version
-
dev tunnel or Ngrok (For local environment testing) latest version (any other tunneling software can also be used)
-
Teams Microsoft Teams is installed and you have an account
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.
- Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
- Install Teams Toolkit for Visual Studio Teams Toolkit extension
- In the debug dropdown menu of Visual Studio, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel.
- In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
- In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
- Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
- 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.
-
Register a new application in the Microsoft Entra ID – App Registrations portal.
-
Setup for Bot
- Register a Microsoft Entra ID aap registration in Azure portal.
- Also, 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.
- 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
- Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
Modify the
/appsettings.json
and fill in the following details:{{BOT-ID}}
- Generated from Step 1 while doing Microsoft Entra ID app registration in Azure portal.{{BOT-PASSWORD}}
-Generated from Step 1, also referred to as Client secret
-
Run in Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
ReceiveMessagesWithRSC
folder - Select
ReceiveMessagesWithRSC.csproj
file - Press
F5
to run the project
- This step is specific to Teams.
-
Edit the
manifest.json
contained in theappPackage
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 themanifest.json
) also update the<<DOMAIN-NAME>>
with the tunnel URL` -
Edit the
manifest.json
for<<MANIFEST-ID>>
replace it with anyGUID
using guid generator. -
Edit the
manifest.json
forwebApplicationInfo
resource"api://botid-{{MicrosoftAppId}}"
with MicrosoftAppId. E.g."api://botid-{{MicrosoftAppId}}"
. -
Zip up the contents of the
appPackage
folder to create amanifest.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 fromappPackage
, 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.
Select a channel and enter a message in the channel for your bot.
The bot receives the message without being @mentioned.
- Showing Welcome message
- Showing messages based on option selected
- Adding to group chat
- Receives messages in group chat without being @mentioned.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.