Skip to content

Latest commit

 

History

History
 
 
page_type description products languages extensions urlFragment
sample
Demonstrating on how a bot can archive groupchat messages and send it to user as a file.
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.

Interaction with app

Bot Archive Group ChatMessagesGif

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)
  • ngrok or equivalent tunneling solution
  • M365 developer account or access to a Teams account with the appropriate permissions to install an app.

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_ngrok_url>/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 Permissions

    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.
  1. Setup NGROK
  • Run ngrok - point to port 3978

    ngrok http -host-header=rewrite 3978
  1. 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 AAD 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
  1. Setup Manifest for Teams
  • This step is specific to Teams.

    • Edit the manifest.json contained in the /appPackage 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.io then your domain-name will be 1234.ngrok.io.
    • Zip up the contents of the /appPackage 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.

Running the sample

Login command interaction:

Bot Welcome

Login successful:

Bot LoginSuccessful

Set up a bot:

Bot Setupbot

Getchat command interaction:

Bot BotCommandToGetChatMessages

Bot is added to fetch messages:

Bot Getchat

Ready to download:

Bot ReplyFromBot

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