Skip to content

Latest commit

 

History

History
 
 

55.teams-link-unfurling

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
deploymentTemplates
deploymentTemplates
 
 
src
src
 
 
teamsAppManifest
teamsAppManifest
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 

README.md

Teams Link Unfurl Bot

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.

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

Prerequisites

  • Java 1.8+
  • Install Maven
  • An account on Azure if you want to deploy to Azure.
  • Microsoft Teams is installed and you have an account
  • 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.

  • Run ngrok - point to port 3978
  • Create Bot Framework registration resource in Azure
  • Update the resources/application.properties 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.)
  • 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")
  • From the root of this project folder:
    • Build the sample using mvn package
    • Unless done previously, install the packages in the local cache by using mvn install
    • Run it by using java -jar .\target\bot-teams-link-unfurl-sample.jar

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