nodejs

page_type	sample
description	This is an sample application which showcases action based messaging extension.
products	office-teams office office-365
languages	nodejs
extensions	contentType createdDate samples 10-04-2022 17:00:25
urlFragment	officedev-microsoft-teams-samples-msgext-action-nodejs

Teams Messaging Extensions Action

Bot Framework v4 Conversation Bot sample for Teams.

This bot has been created using Bot Framework. This sample shows how to incorporate basic conversational flow into a Teams application. It also illustrates a few of the Teams specific calls you can make from your bot.

• 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/msgext-action/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

5. Run your bot at the command line:

   npm start

6. 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 bot to personal/team/groupChat scope (Supported scopes)

Running the sample

Note this manifest.json specified that the bot will be called from both the compose and message areas of Teams. Please refer to Teams documentation for more details.

1. Selecting the Create Card command from the Compose Box command list. The parameters dialog will be displayed and can be submitted to initiate the card creation within the Messaging Extension code.

2. Selecting the Fetch Roster command from the Compose Box command list. You will presented with prompt for Just In Time installation if app is not already added to current team/chat.

3. You can try with other supported commands as well like: Adaptive Card, Web View, HTML, Razor View

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

• Messaging Extensions are a special kind of Microsoft Teams application that is supported by the Bot Framework v4.

There are two basic types of Messaging Extension in Teams: Search-based and Action-based. This sample illustrates how to build an Action-based Messaging Extension.