csharp

page_type	description	products	languages	extensions	urlFragment
sample	This sample illustrates how you can use Proactive installation of app for user and send proactive notification by calling Microsoft Graph APIs through bot.	office-teams office office-365	csharp	contentType createdDate samples 07/07/2021 01:38:26 PM	officedev-microsoft-teams-samples-graph-proactive-installation-csharp

Proactive Installation Sample App

This sample app illustartes the proactive installation of app using Graph API and sending proactive notification to users from GroupChat or Channel.

Language Used : C#

Included Features

• Bots

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

Proactive Installation Sample App: Manifest

Prerequisites

• Microsoft Teams is installed and you have an account
• .NET Core SDK version 6.0
• dev tunnel or ngrok latest version or equivalent tunnelling solution

Setup

1. Register a new application in the Microsoft Entra ID – App Registrations portal.

• Required Microsoft graph Application level permissions to run this sample app
• Get consent for the Application permissions by following steps mentioned here.

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

   NOTE: When you create your 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

4. 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:

  • {{YOUR-MICROSOFT-APP-ID}} - Generated from Step 1 while doing Microsoft Entra ID app registration in Azure portal.
  • {{ YOUR-MICROSOFT-APP-PASSWORD}} - Generated from Step 1, also referred to as Client secret
  • {{ YOUR-APPCATALOG-TEAM-ID }} - To get TeamsappcatalogAppId you first navigate to following link in your browser Get TeamsAppCatalogId from Microsoft Graph explorer. Then search with app name or based on Manifest App id in Graph Explorer response and copy the Id [i.e teamApp.Id]

  

• Run the bot from Visual Studio:

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to samples/graph-proactive-installation/csharp folder
  • Select ProactiveAppInstallation.sln file
  • Press F5 to run the project

4. 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)
  • 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 an app to your org's app catalog")

  • Go to Microsoft Teams. From the lower left corner, select Apps
  • From the lower left corner, choose Upload an app to your org's app catalog
  • 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.

Running the sample

Interacting with the Proactive installation App in Teams

• Install the Proactive App Installation demo in a Team or GroupChat.

  

• Run Check and install to pro-actively installs the App for all the users in team.

• Run Check and install to pro-actively installs the App for all the users in team. After installation send 'Send message' command to send proactive message.

  

• Group Chat

  

• Team Scope

  

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

Further reading

• Proactive App Installation using Graph API
• Bot Framework Documentation
• Bot Basics
• Azure Bot Service Introduction
• Azure Bot Service Documentation