Name		Name	Last commit message	Last commit date
parent directory ..
.vscode		.vscode
Bots		Bots
Images		Images
appManifest		appManifest
appManifest_Hub		appManifest_Hub
assets		assets
env		env
infra		infra
pages		pages
resources		resources
.env		.env
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
README.md		README.md
build.js		build.js
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json
teamsapp.local.yml		teamsapp.local.yml
teamsapp.yml		teamsapp.yml

README.md

page_type

description

products

languages

extensions

urlFragment

sample

This Teams sample application illustrates how to use deeplinks for initiating calls, video chats, and navigating within various app tabs. It includes detailed setup instructions and supports interactions with bots and tabs to enhance user experience.

office-teams

office

office-365

nodejs

contentType	createdDate
samples	07-07-2021 13:38:27

officedev-microsoft-teams-samples-tab-deeplink-nodejs

DeepLink

Explore this Microsoft Teams sample app designed to demonstrate the use of deeplinks for seamless interactions, including calls, chats, and navigation across tabs and applications. Featuring bot integration and comprehensive setup guidance, this app empowers developers to create engaging and efficient communication experiences within Teams.DeepLink

Included Features

Tabs
Bots
Deep Links

Interaction with app.

Prerequisites

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)
dev tunnel or ngrok latest version or equivalent tunneling solution
M365 developer account or access to a Teams account with the
Teams Toolkit for VS Code or TeamsFx CLI

Run the app (Using Teams Toolkit for Visual Studio Code)

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.

Setup.

Register a new application in the Microsoft Entra ID – App Registrations portal.
Setup for Bot

In Azure portal, create a Azure Bot resource.
Ensure that you've enabled the Teams Channel
While registering the bot, use https://<your_tunnel_domain>/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.

Setup NGROK

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
```

Setup for code

Clone the repository

git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

Update the .env configuration for the bot to use the YOUR-MICROSOFT-APP-ID, YOUR-MICROSOFT-APP-PASSWORD and BASE-URL is tunnel url eg. 124.ngrok-free.app. (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.)
navigate to Deeplink.html page at line number 58 Update the data-app-id attribute with your application id.
```
data-app-id="{{Your-App-Id}}"
```
- In a terminal, navigate to samples/tab-deeplink/nodejs
```
cd samples/tab-deeplink/nodejs
```
- Install modules
```
npm install
```
- Navigate to env.js file and update your AppId at placeholder <<App-ID>> (You can get it manually frrm teams admin portal.
- Start the bot
```
npm start
```
- If you are using Visual Studio code
- Launch Visual Studio code
- Folder -> Open -> Project/Solution
- Navigate to samples/tab-deeplink/nodejs folder
- Select nodejs Folder
- To run the application required node modules.Please use this command to install modules npm i.

Setup Manifest for Teams

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 app registration 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)
- Edit the manifest.json for validDomains and replace {{domain-name}} with base Url of your domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms. Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the manifest.json in the tab-deeplink\nodejs\appManifest_Hub folder with the required values.
- Zip up the contents of the appManifest folder to create a appManifest.zip or appManifest_Hub folder to create a appManifest_Hub.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 the Apps view click "Upload a custom app")
- Go to Microsoft Teams. From the lower left corner, select Apps
- From the lower left corner, choose Upload a custom App
- Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Interacting with the bot

Enter text in the emulator. The text will be echoed back by the bot.

Interact with DeepLink bot by pinging it in personal or channel scope.

Select the option from the options displayed in the adaptive card. This will redirect to the respective Task in the Tab.

Click on Back to List to view all the options and additional features of deep link using Microsoft teams SDK v2.0.0. User can select an option which will redirect to the respective Task in the Tab.

Add this application in live meeting and stage the content.

While it's in stage view, using same deeplink to open tab will open the meeting side panel tab.

Deeplink to meeting side panel:

@mention bot in meeting chat to get an adaptive card.

Click on Side Panel Deeplink which will redirect to the meeting side panel. Note: When the deeplink is opened outside meeting, it will redirect to meeting details tab.