Skip to content

Latest commit

 

History

History
 
 

55.teams-link-unfurling

README.md

TeamsLinkUnfurlingBot

Bot Framework v4 Teams link unfurling bot sample for Teams.

This bot has been created using Bot Framework, it shows how to create a simple bot that performs link unfurling in Teams.

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

    • Open the solution samples\csharp_dotnetcore\csharp_dotnetcore.sln
    • Set the Startup Project to TeamsLinkUnfurling
    • The changes specified here will apply to this project

  3. Run ngrok - point to port 3978

    ngrok http -host-header=rewrite 3978

  4. Create Bot Framework registration resource in Azure

  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 in Teams

Note the Teams manifest.json for this sample also includes a Search Query. This Messaging Extension is only introduced in order to enable installation, because there is no mechanism for installing a link unfurling feature in isolation.

If you copy and paste a link from https://www.BotFramework.com into the compose message area the link will unfurl.

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