Skip to content

Latest commit

 

History

History

csharp

README.md

page_type description products languages extensions urlFragment
sample
This sample app demonstrate how to use link unfurling in Messaging Extension using Bot Framework v4
office-teams
office
office-365
csharp
contentType createdDate
samples
10/17/2019 13:38:25 PM
officedev-microsoft-teams-samples-msgext-link-unfurling-csharp

Teams Link Unfurl Bot C#

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

msgext-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
  • .NET SDK version 6.0
  • dev tunnel or ngrok latest version or equivalent tunnelling solution

Setup

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. Setup for Bot

    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,

  3. If you are using Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples/msgext-link-unfurling/csharp folder
    • Select TeamsLinkUnfurling.csproj or TeamsLinkUnfurling.slnfile

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

  5. Update the appsettings.json configuration for the bot to use the MicrosoftAppId, MicrosoftAppPassword, MicrosoftAppTenantId generated in Step 2 (App Registration creation). (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.)

    • Set "MicrosoftAppType" in the appsettings.json. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)

  6. Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.

  7. 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 (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.)

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

Running the sample

Add-App

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 the link https://teamstestdomain.com/teams/csharp, 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. Link-Unfurling

Outlook on the web

  • To view your app in Outlook on the web.

  • Go to Outlook on the weband sign in using your dev tenant account.

After opening Outlook web, click the "New mail" button.

Open New Mail

on the tool bar on top,select Apps icon. Your sideloaded app title appears among your installed apps

OpenAppIcon

Select your app icon to launch your app in Office on the web

Search in Extension

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