nodejs

page_type	description	products	languages	extensions	urlFragment
sample	Sample which demonstrates how to archive groupchat messages and send it to user as a file using bot.	office-teams office office-365	nodejs	contentType createdDate samples 10/11/2021 23:35:25 PM	officedev-microsoft-teams-samples-bot-archive-groupchat-messages-nodejs

Archive groupchat messages

Using this nodejs sample, a bot can archive chat messages of groupchat and send it to user.

This feature shown in this sample is currently available in Public Developer Preview only.

Included Features

• Teams SSO (bots)
• Adaptive Cards
• Graph API

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 appropriate permissions to install an app.
• 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.

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.

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

Instruction on setting connection string for bot authentication on the behalf of user

1. In the Azure portal, select your resource group from the dashboard.

2. Select your Azure bot registration link.

3. Open the resource page and select Configuration under Settings.

4. Select Add OAuth Connection Settings.

5. Complete the form as follows:

   a. Name: Enter a name for the connection. You'll use this name in your bot in the appsettings.json file. For example BotTeamsAuthADv1.

   b. Service Provider: Select Azure Active Directory V2. Once you select this, the Azure AD-specific fields will be displayed.

   c. Client id: Enter the Application (client) ID .

   d. Client secret: Enter the Application (client) secret.

   e. Provide Scopes like "User.Read Chat.ReadWrite ChatMessage.Read"

6. Go to the Azure portal where app registration is created.

   a. Add this permission to app registration

   • Chat.ReadWrite
   • ChatMessage.Read

   b. Under left menu, select Authentication under Manage section.

   • Select 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)' under Supported account types and click "+Add a platform".
   • On the flyout menu, Select "Web"
   • Add https://token.botframework.com/.auth/web/redirect under Redirect URLs and click Configure button.
   • Once the flyout menu close, scroll bottom to section 'Implicit Grant' and select check boxes "Access tokens" and "ID tokens" and click "Save" at the top bar.

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

3. Setup for code

• Clone the repository

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

• In a terminal, navigate to samples/bot-archive-groupchat-messages/nodejs

• Install modules

  npm install

• Update the .env configuration for the bot to use the MicrosoftAppId and MicrosoftAppPassword and ConnectionName from the Microsoft Entra ID app registration or from the Bot Framework registration. (Note that the MicrosoftAppId is the AppId created in step 1 (Setup for Bot SSO), the MicrosoftAppPassword is referred to as the "client secret" in step 1 (Setup for Bot SSO) and you can always create a new client secret anytime.) Also, update connectionName as the name of your Azure Bot connection created in previous steps.

• Run your bot at the command line:

  npm start

4. Setup Manifest for Teams

• This step is specific to Teams.

  • Edit the manifest.json contained in the /appManifest folder to and fill in MicrosoftAppId (that was created in step 1 and it is the same value of MicrosoftAppId as in .env file) everywhere you see the place holder string <<MICROSOFT-APP-ID>> (depending on the scenario it may occur multiple times in the manifest.json) Update valid domains for <<DOMAIN-NAME>> 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.
  • 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

Login command interaction:

Login successful:

Set up a bot:

Getchat command interaction:

Bot is added to fetch messages:

Ready to download:

Interacting with the bot in GroupChat

Select a groupchat and add the bot to chat.

Send getchat message to the bot, you will recieve a consent card by the bot in your personal scope.

Further reading

• 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