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.
- Microsoft Teams is installed and you have an account
- ngrok or equivalent tunnelling solution
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.
-
Clone the repository
git clone https://github.com/Microsoft/botbuilder-samples.git
-
Run ngrok - point to port 3978
ngrok http -host-header=rewrite 3978
-
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
- Use the current
-
Bring up a terminal, navigate to
botbuilder-samples\samples\python\55.teams-link-unfurling
folder -
Activate your desired virtual environment
-
Install dependencies by running
pip install -r requirements.txt
in the project folder. -
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.) -
This step is specific to Teams.
- Edit the
manifest.json
contained in theteamsAppManifest
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 themanifest.json
) - Zip up the contents of the
teamsAppManifest
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the Apps view click "Upload a custom app")
- Edit the
-
Run your bot with
python app.py
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.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.