page_type | description | products | languages | extensions | contentType | createdDate | urlFragment | |||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample demos the feature of link unfurling for share to teams. |
|
|
samples |
14-12-2022 00:15:13 |
officedev-microsoft-teams-samples-app-link-unfurling-in-share-to-teams-nodejs |
This sample demos the feature of link unfurling for share to teams (The Share to Teams feature allows site users to easily share a site and content to individual contacts or groups on Teams.).
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).
App check-in location: Manifest
- Microsoft Teams is installed and you have an account (not a guest account)
- To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher)
- ngrok or equivalent tunneling solution
- M365 developer account or access to a Teams account with the appropriate permissions to install an app.
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.
- In Azure portal, create a Azure Bot resource.
- Ensure that you've enabled the Teams Channel
- While registering the bot, use
https://<your_ngrok_url>/api/messages
as the messaging endpoint. NOTE: When you create app registration, you will create an App ID and App password - make sure you keep these for later.
-
Run ngrok - point to port 3978
ngrok http -host-header=rewrite 3978
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In a terminal, navigate to
samples/app-link-unfurling-in-share-to-teams/nodejs
-
Install modules
npm install
-
Update the
.env
configuration for the bot to use theMicrosoftAppId
andMicrosoftAppPassword
,BaseUrl
with application base url. For e.g., your ngrok url. (Note the MicrosoftAppId is the AppId created in step 1 (Setup for Bot), the MicrosoftAppPassword is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.) -
Run your app
npm start
- This step is specific to Teams.
- Edit the
manifest.json
contained in the ./AppPackage folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) everywhere you see the place holder string{{Microsoft-App-Id}}
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) - Edit the
manifest.json
forvalidDomains
and replace{{domain-name}}
with base Url of your domain. E.g. if you are using ngrok it would behttps://1234.ngrok.io
then your domain-name will be1234.ngrok.io
. - Zip up the contents of the
AppPackage
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)
- Edit the
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.