python

page_type	description	products	languages	extensions	urlFragment
sample	This sample app demonstrate the bot that performs link unfurling in Teams	office-teams office office-365	python	contentType createdDate samples 12-12-2019 13:38:25	officedev-microsoft-teams-samples-bot-msgext-link-unfurling-python

Teams Link Unfurl Bot Python

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.

Included Features

• Bots
• Message Extensions
• Search Commands
• Link Unfurling

Interaction with Messaging Extension Link Unfurling

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 manifest (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Teams Link Unfurl Bot: Manifest

Prerequisites

• Microsoft Teams is installed and you have an account
• dev tunnel or ngrok latest version 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/OfficeDev/Microsoft-Teams-Samples.git

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

3. Create Bot Framework registration resource in Azure

   • Use the current https URL you were given by running the tunnelling application. 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

4. Bring up a terminal, navigate to Microsoft-Teams-Samples\samples\msgext-link-unfurling\python folder

5. Activate your desired virtual environment

6. Install dependencies by running pip install -r requirements.txt in the project folder.

7. Update the config.py 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.)

8. 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 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 appManifest folder to create a manifest.zip
   • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

9. Run your bot with python app.py

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

• Link unfurling
• Bot Framework Documentation
• Bot Basics
• Azure Bot Service Introduction
• Azure Bot Service Documentation