page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample app showcases a Node.js bot that implements link unfurling within Microsoft Teams messaging extensions. |
|
|
|
officedev-microsoft-teams-samples-msgext-link-unfurling |
This sample app illustrates a Node.js bot designed for Microsoft Teams, showcasing the link unfurling feature within messaging extensions. By integrating with Azure, it enables seamless interaction with links shared in chat, improving the user experience.
If you copy and paste the link https://teamstestdomain.com/teams/test
or your tunnel base url, it wil unfurl inside compose area.
- Note : To enable link unfurling for your domain, add your domain to the manifest.json file under message handlers.
- Bots
- Message Extensions
- Search Commands
- Link Unfurling
Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.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
- Microsoft Teams is installed and you have an account
- NodeJS
- dev tunnel or ngrok latest version or equivalent tunnelling solution
- Teams Toolkit for VS Code or TeamsFx CLI
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
- Select Debug > Start Debugging or F5 to run the app in a Teams web client.
- In the browser that launches, select the Add button to install the app to Teams.
If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.
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
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
In Azure portal, create a Azure Bot resource. - For bot handle, make up a name. - Select "Use existing app registration" (Create the app registration in Microsoft Entra ID beforehand.) - If you don't have an Azure account create an Azure free account here
In the new Azure Bot resource in the Portal,
- Ensure that you've enabled the Teams Channel
- In Settings/Configuration/Messaging endpoint, enter the current https
URL you were given by running the tunnelling application. Append with the path /api/messages
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In a terminal, navigate to
samples/msgext-link-unfurling/nodejs
-
Install modules
npm install
-
Update the
.env
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.)MicrosoftAppTenantId
will be the id for the tenant where application is registered.- Set "MicrosoftAppType" in the
.env
. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)
- Set "MicrosoftAppType" in the
-
Run your bot at the command line:
npm start
-
This step is specific to Teams.
- Edit the
manifest.json
contained in theappManifest
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
appManifest
folder to create amanifest.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package) - Upload the
manifest.zip
to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
- Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
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://teamstestdomain.com/teams/test 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.