csharp

page_type	description	products	languages	extensions	urlFragment
sample	This sample demonstrates a C# bot that enables users to share and collaboratively review links in Microsoft Teams meetings.	office-teams office office-365	csharp	contentType createdDate samples 04/03/2022 11:00:00	officedev-microsoft-teams-samples-msgext-link-unfurling-meeting-csharp

Link unfurling meeting sample

This sample application highlights a C# bot designed for Microsoft Teams, showcasing the link unfurling feature that enhances collaboration in meetings. By allowing users to share links and review content through adaptive cards, the bot streamlines the process of discussing resources during group discussions.

1. Workflow:

• User shares a link to a dashboard with a group of users.
• Teams app unfurls the link to an adaptive card with actions to view it in a stage tab or review it in a meeting.

2. Workflow:

• Other user in the group chooses to review the dashboard in a meeting.
• Teams app creates a new meeting, adds a tab (that points to the dashboard originally shared) to a meeting.
• User automatically joins the meeting and reviews the tab.
• User shares the tab to meeting stage view with other users.

Interaction with app

Prerequisites

• .NET Core SDK version 6.0

  # determine dotnet version
  dotnet --version

• Publicly addressable https url or tunnel such as dev tunnel or ngrok latest version or Tunnel Relay

• Teams Toolkit for Visual Studio

Run the app (Using Teams Toolkit for Visual Studio)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.

1. Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
2. Install Teams Toolkit for Visual Studio Teams Toolkit extension
3. In the debug dropdown menu of Visual Studio, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel.
4. In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
5. In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
7. Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
8. 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

1. Register a new application in the Microsoft Entra ID – App Registrations portal. Select New Registration and on the register an application page, set following values:
   • Set name to your app name.
   • Choose the supported account types (any account type will work)
   • Leave Redirect URI empty.
   • Choose Register.
   • On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You’ll need those later when updating your Teams application manifest and in the appsettings.json.
   • Under Manage, select Expose an API.
   • Select the Set link to generate the Application ID URI in the form of api://{AppID}. Insert your fully qualified domain name (with a forward slash "/" appended to the end) between the double forward slashes and the GUID. The entire ID should have the form of: api://fully-qualified-domain-name/{AppID}
   • ex: api://%ngrokDomain%.ngrok-free.app/00000000-0000-0000-0000-000000000000.

• Select the Add a scope button. In the panel that opens, enter access_as_user as the Scope name.

• Set Who can consent? to Admins and users

• Fill in the fields for configuring the admin and user consent prompts with values that are appropriate for the access_as_user scope:

  • Admin consent display name: Teams can access the user’s profile.
  • Admin consent description: Allows Teams to call the app’s web APIs as the current user.
  • User consent display name: Teams can access the user profile and make requests on the user's behalf.
  • User consent description: Enable Teams to call this app’s APIs with the same rights as the user.

• Ensure that State is set to Enabled

• Select Add scope

  • The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with /access_as_user appended to the end:
    • `api://[ngrokDomain].ngrok-free.app/00000000-0000-0000-0000-000000000000/access_as_user.

• In the Authorized client applications section, identify the applications that you want to authorize for your app’s web application. Each of the following IDs needs to be entered:

  • 1fec8e78-bce4-4aaf-ab1b-5451cc387264 (Teams mobile/desktop application)
  • 5e3ce6c0-2b1f-4285-8d4b-75ee78787346 (Teams web application)

• Navigate to API Permissions, and make sure to add the follow permissions:

• Select Add a permission

•  Select Microsoft Graph -> Delegated permissions.

  • User.Read (enabled by default)
  • TeamsAppInstallation.ReadWriteSelfForChat
  • TeamsTab.ReadWriteForChat
  • Chat.ReadBasic
  • OnlineMeetings.ReadWrite

• Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

• Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app. Set a redirect URI:

  • Select Add a platform.
  • Select web.
  • Enter the redirect URI for the app in the following format:

  • https://token.botframework.com/.auth/web/redirect,

  • https://<your_tunnel_domain>/auth-end

  • https://<your_tunnel_domain>/auth-start This will be the page where a successful implicit grant flow will redirect the user.

    Enable implicit grant by checking the following boxes:
    ✔ ID Token
    ✔ Access Token

• Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the appsettings.json.

  • Add authentication to your Teams bot
    • Follow steps to add OAuth connection setting on this page
  • Make sure to copy and save OAuth connection name.
  • For Scopes, enter all the delegated graph permissions configured in the app(TeamsAppInstallation.ReadWriteSelfForChat TeamsTab.ReadWriteForChat Chat.ReadBasic OnlineMeetings.ReadWrite).
  • Update Bot messaging endpoint to tunnel url with messaging endpoint. (ex. https://<randomsubdomain>.ngrok-free.app/api/messages).

  Add OAuth connection:

  

2. Setup for Bot

• Register a bot with Azure Bot Service, following the instructions here.
• 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 your bot you will create an App ID and App password - make sure you keep these for later.

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

4. Setup for code

• Clone the repository

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

• Update the appsettings.json files.

• Clone the repo or download the sample code to your machine.
• Update the following settings in appsettings.json
  • MicrosoftAppId - App ID saved earlier.
  • ClientId - App ID saved earlier.
  • TeamsBot:AppId - App ID saved earlier.
  • MicrosoftAppPassword - App secret saved earlier.
  • ClientSecret - App secret saved earlier.
  • AzureAd.domain - Replace with tunnel domain. (ex. <randomsubdomain>.ngrok-free.app)
  • ConnectionName - Connection name
  • BaseUrl - tunnel url saved earlier.
  • TenantId - Tenant ID where you wll run the Teams application.
  • CatalogAppId - App ID in organization's app store saved earlier.
  • GraphApiBeta.Scopes add the following graph permission(TeamsAppInstallation.ReadWriteSelfForChat TeamsTab.ReadWriteForChat Chat.ReadBasic OnlineMeetings.ReadWrite)
• Update the following in .env under ClientApp.
  • REACT_APP_BASE_URL - tunnel url saved earlier.
  • REACT_APP_AZURE_APP_REGISTRATION_ID - App ID saved earlier.
• Build and run the sample code in Visual studio / Visual studio code.

• Run the bot from a terminal or from Visual Studio:

  A) From a terminal, navigate to samples\msgext-link-unfurling-meeting\csharp\Source

  # run the bot
  dotnet run

  B) Or from Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to samples\msgext-link-unfurling-meeting\csharp\Source folder
  • Select LinkUnfurling.csproj file
  • Press F5 to run the project

5. Troubleshooting

• If the web application fails to load, run npm install and npm run build under ClientApp folder.
• If the meeting setup fails with 403 (Not authorized), make sure you grant admin consent on behalf of all the users.
• Grant admin conset - https://login.microsoftonline.com/{tenant-id}/adminconsent?client_id={client-id} where
• {client-id} is the app ID saved earlier.
• {tenant-id} is your organization's tenant ID.

6. Setup Manifest for Teams

• 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 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)

  • Edit the manifest.json for websiteUrl,privacyUrl,termsOfUseUrl inside DeveloperTabs . Replace <your_tunnel_domain> with base Url 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.

  • Edit the manifest.json for validDomains with base Url 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.

  • Edit the manifest.json for showLoadingIndicator Replace false.

  • Zip up the contents of the appPackage 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.)

  • Add the app to personal/team/groupChat scope (Supported scopes)

Running the sample

Publish the app package to organization's app store:

Build for your org:

Install App(personal):

Create link - https://<your_tunnel_domain>/dashboard1:

Send Card UI:

View:

Install App(groupChat):

Add link unfurling to group chat:

Configuration groupChat UI:

Shared Dashboard:

Join Meeting:

Share dashboard screen UI:

Screen sharing:

Install App(team):

Add link unfurling to team:

Configuration team UI:

Shared dashboard team:

9. Project Structure

• The sample contains 3 projects
  • Web - Exposes REST APIs (including Bot messaging endpoint) for clients to consume and contains ClientApp logic.
  • Domain - Contains the business logic to setup online meetings based on where the resource is shared.
  • Infrastructure - Fulfills Domain's dependencies. Example - resource service, card factory to prepare card etc. If you want to change AC, or connect to a resource service, this is where you would make the changes.

10. Basic Tests

• You should be able to install the application to personal scope, group chats and Teams.
• Share a link say https://<your_tunnel_domain>/dashboard1 and application should prompt the user to sign-in and unfurl it to an adaptive card post sign-in.
• You should be able to open stage tab view from adaptive card.
• You should be able to setup a meeting with everything configured.

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

• Conversational bots in teams
• Conversation Basics
• Universal Bots in Teams
• List Meeting Attendance Reports
• List Attendance Records
• Configure application access policy
• Bot Framework Documentation
• Bot Basics
• Azure Portal
• Add Authentication to Your Bot Via Azure Bot Service
• Activity processing
• Azure Bot Service Introduction
• Azure Bot Service Documentation
• .NET Core CLI tools
• Azure CLI
• Azure Portal
• Language Understanding using LUIS
• Channels and Bot Connector Service
• Microsoft Teams Developer Platform