Teams Just In Time Installation Bot

Bot Framework v4 Just In Time Installation Bot sample for Teams.

This bot has been created using Bot Framework. This sample shows how to do a just in time installation of your app in a conversation. the sample code check if the Bot is installed in current context (by fetching the roaster) or not if Bot is installed in current context it sends an adaptive card inputs else it throws a Just in time installation dialog to the user so they can install the app. Please check Request to Install your conversational Bots for more information about just in time installation

Prerequisites

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

To try this sample

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

1. Clone the repository

   git clone https://github.com/Microsoft/botbuilder-samples.git

2. If you are using Visual Studio

   • Launch Visual Studio
   • File -> Open -> Project/Solution

3. Run ngrok - point to port 3978

   ngrok http -host-header=rewrite 3978

4. Create Bot Framework registration resource in Azure

   • Use the current https URL you were given by running ngrok. Append with the path /api/messages used by this sample
   • Ensure that you've enabled the Teams Channel
   • If you don't have an Azure account you can use this Bot Framework registration

5. Update the appsettings.json configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)

6. This step is specific to Teams.

   • Edit the manifest.json contained in the teamsAppManifest 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)
   • Zip up the contents of the teamsAppManifest folder to create a manifest.zip
   • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

7. Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.

Interacting with the bot

You can test this bot by invoking the Message Extension from a conversation where this app has not been installed.

Avoiding Permission-Related Errors

You may encounter permission-related errors when sending a proactive message. This can often be mitigated by using MicrosoftAppCredentials.TrustServiceUrl(). See the documentation for more information.

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

• How Microsoft Teams bots work