nodejs

page_type	description	products	languages	extensions	urlFragment
sample	This is an sample application which showcases how to invoke task module from adaptive and hero cards.	office-teams office office-365	nodejs	contentType createdDate samples 10-04-2022 17:00:25	officedev-microsoft-teams-samples-bot-task-module-nodejs

Teams Task Module

Bot Framework Teams Task Module sample.

This bot has been created using Bot Framework. It shows how to fetch a Task Module from a Hero Card button and receive input from an Adaptive Card in the Task Module.

• Interaction with bot

Prerequisites

• Microsoft Teams is installed and you have an account
• NodeJS
• ngrok or equivalent tunnelling solution

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. Run ngrok - point to port 3978

   ngrok http --host-header=rewrite 3978

Setup for bot

In Azure portal, create a Azure Bot resource. - For bot handle, make up a name. - Select "Use existing app registration" (Create the app registration in Azure Active Directory beforehand.) - If you don't have an Azure account create an Azure free account here

In the new Azure Bot resource in the Portal, - Ensure that you've enabled the Teams Channel - In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running ngrok. Append with the path /api/messages

Setup for code

1. Clone the repository

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

2. In a terminal, navigate to samples/bot-task-module/nodejs

3. Install modules

   npm install

4. Update the .env configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.) MicrosoftAppTenantId will be the id for the tenant where application is registered.

• Set "MicrosoftAppType" in the .env. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)

• Set "BaseUrl" in the .env as per your application like the ngrok forwarding url (ie https://xxxx.ngrok.io) after starting ngrok

1. Run your bot at the command line:

   npm start

2. 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 bot earlier) everywhere you see the place holder string <<YOUR-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 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 (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 Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
   • Add the app in personal/groupchat/team scope (supported scopes)

Running the sample

Note this manifest.json specified that the bot will be installed in "personal", "team" and "groupchat" scope which is why you immediately entered a one on one chat conversation with the bot. You can at mention the bot in a group chat or in a Channel in the Team you installed it in. Please refer to Teams documentation for more details.

You can interact with this bot by sending it a message. The bot will respond with a Hero Card and Adaptive Card with buttons which will display a Task Module when clicked. The Task Modules demonstrate retrieving input from a user, or displaying custom web page content.

• Personal Scope Interactions:

• Group Chat Scope Interactions:

• Team Scope Interactions:

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

• How Microsoft Teams bots work