Skip to content

Latest commit

 

History

History

nodejs

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
nodejs
contentType createdDate
samples
12/24/2021 12:00:00 AM
officedev-microsoft-teams-samples-bot-join-team-using-qr-code-nodejs

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

Bot Join TeamUsing QRCodeGif

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

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.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. 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

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.

Setup for Bot SSO

a) In Azure portal, create a Azure Bot resource..

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

Install App

Code setup

  1. Clone the repository

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

  2. In a terminal, navigate to samples/bot-join-team-using-qr-code/nodejs

  3. Install node modules

    Inside node js folder, open your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.

    npm install

  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. Open the .env configuration file in your project folder (or in Visual Studio Code) and update the following details:

  • MicrosoftAppId - It is the AppId created in previous step (Setup for Bot SSO)
  • MicrosoftAppPassword - It is referred to as the "client secret" in step 1.a (Setup for Bot SSO) and you can always create a new client secret anytime
  • ConnectionName - Generated from Step 1.a, 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.
  • BaseUrl with application base url. For example your ngrok url like https://12123xxxx.ngrok-free.app and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.

  1. Run your app

    npm start

Manually update the manifest.json

  • Edit the manifest.json contained in the appManifest/ folder to replace with your MicrosoftAppId (that was created in previous step while doing Microsoft Entra ID app registration and is the same value of MicrosoftAppId in .env file) 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)

  • Also, update {{domain-name}} in your manifest validDomains section with your app domain like ngrok domain 1234.ngrok-free.app or dev tunnels domain 12345.devtunnels.ms excluding http/https.

  • Zip up the contents of the appManifest/ folder to create a manifest.zip

  • Upload the manifest.zip to Teams (in the left-bottom Apps view, click "Upload a custom app")

IMPORTANT: The manifest file in this app adds "token.botframework.com" to the list of validDomains. This must be included in any bot that uses the Bot Framework OAuth flow.

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

Running the sample

Card With Buttons

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

JoinTeam

  • 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

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