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. |
|
|
|
officedev-microsoft-teams-samples-bot-archive-groupchat-messages-nodejs |
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.
- Sending archive chat messages text file of a groupchat to user
- Microsoft Teams is installed and you have an account (not a guest account)
- NodeJS
- ngrok or equivalent tunneling solution
- M365 developer account or access to a Teams account with the appropriate permissions to install an app.
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.
In Azure portal, create a Bot Framework registration resource.
- Ensure that you've enabled the Teams Channel
-
In the Azure portal, select your resource group from the dashboard.
-
Select your bot channel registration link.
-
Open the resource page and select Configuration under Settings.
-
Select Add OAuth Connection Settings.
-
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"
-
Go to the Azure portal where app registration is created.
a. Add this permission to app registration
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.
-
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
-
Run ngrok - point to port 3978
ngrok http -host-header=rewrite 3978
-
Update the
.env
configuration for the bot to use theMicrosoftAppId
andMicrosoftAppPassword
andConnectionName
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.) -
Run your bot at the command line:
npm start
-
Manually update the manifest.json
- 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 themanifest.json
) - In the valid domains section of the manifest update your ngrok url
{<<ngrokid>>.ngrok.io}
. - Zip up the contents of the
/appPackage
folder to create amanifest.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. - Edit the
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.