Skip to content

Latest commit

 

History

History

csharp

README.md

page_type description products languages extensions urlFragment
sample
This bot allows users to join Microsoft Teams by scanning a team-specific QR code.
office-teams
office
office-365
csharp
contentType createdDate
samples
12/24/2021 12:00:00 AM
officedev-microsoft-teams-samples-bot-join-team-using-qr-code-csharp

Join a team using QR code sample

This Microsoft Teams sample bot helps users join a team by scanning a QR code that contains the team ID. It allows users to generate QR codes, leverages the Graph API, and supports both bot and Adaptive Cards functionality. Ideal for mobile clients, this feature enhances team onboarding with ease.

Currently, Microsoft Teams support for QR or barcode scanner capability is only supported for mobile clients

Included Features

  • Bots
  • Adaptive Cards
  • Graph API

Interaction with app

Card

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

Join a team using QR code: Manifest

Prerequisites

  • .NET Core SDK version 6.0

    determine dotnet version

    dotnet --version

  • dev tunnel or Ngrok (For local environment testing) latest version (any other tunneling software can also be used)

  • Teams Microsoft Teams is installed and you have an account

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.
  • 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)
    • Directory.AccessAsUser.All
    • TeamMember.ReadWrite.All
    • Click on Add permissions.

Permissions

  1. Setup for Bot

    • Also, 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 app registration, you will create an App ID and App password - make sure you keep these for later.

-In the Azure Portal, navigate back to the Azure Bot resource created (https://learn.microsoft.com/microsoftteams/platform/bots/how-to/authentication/add-authentication?tabs=dotnet%2Cdotnet-sample#azure-ad-v2) -Switch to the "Settings" blade and click "Add Setting" under the OAuth Connection Settings section

  • Enter a name for your new Connection setting.
    • In the Service Provider dropdown, select Azure Active Directory V2
    • Enter in the client id and client secret obtained in step 1 and 1
    • For the Token Exchange URL use the Application ID URL obtained in step 1
    • Specify "common" as the Tenant ID
    • Add all the scopes configured when specifying permissions to downstream APIs in step 1
    • Click "Save"

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

  2. Setup for code

  • Clone the repository

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

  • Modify the /appsettings.json and fill in the following details:

  • {{ MicrosoftAppId }} - Generated from Step 1 is the application app id

  • {{ MicrosoftAppPassword }} - Generated from Step 1, also referred to as Client secret

  • {{ ConnectionName }} - Generated from Step 2, is the name that we provide while adding OAuth connection setting in Azure Bot resource. Please follow Add authentication to bot to configure the connection.

  • {{ ApplicationBaseUrl }} - Your application's base url. E.g. https://12345.ngrok-free.app if you are using ngrok and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.

  • In a terminal, navigate to JoinTeamByQR

```bash
# change into project folder
cd # JoinTeamByQR
```

  • Run the bot from a terminal or from Visual Studio, choose option A or B.

  • From a terminal

    # run the bot
dotnet run

  • Or from Visual Studio

  • Launch Visual Studio

  • File -> Open -> Project/Solution

  • Navigate to samples/bot-join-team-using-qr-code/csharp folder

  • Select JoinTeamByQR.csproj file

  • Press F5 to run the project

  1. 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 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 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.
    • Edit the manifest.json for webApplicationInfo resource "api://botid-{{MicrosoftAppId}}" 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 "api://botid-{{MicrosoftAppId}}".
    • 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 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 ./appPackage 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.

Running the sample

  • Type a message to get a card to generate the QR code.

Card

  • Select the team from dropdown list for which you want to generate the QR code and then click on 'Generate QR' button.

QR Code

  • Scan the generated QR code to join the team.

Join Team

  • After Scan the Qr Code Added user in team successfully.

Join Team

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