nodejs

page_type	description	products	languages	extensions	urlFragment
sample	This sample showcases usage of various conversation events for teams bot for both personal and teams scope.	office-teams office office-365	nodejs	contentType createdDate samples 10-04-2022 20:15:25	officedev-microsoft-teams-samples-bot-conversation-nodejs

Teams Conversation Bot

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/bot-conversation/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.

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

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

Running the sample

You can interact with this bot in Teams by sending it a message, or selecting a command from the command list. The bot will respond to the following strings.

1. Show Welcome

• Result: The bot will send the welcome card for you to interact with

• Valid Scopes: personal, group chat, team chat

• Personal Scope Interactions:

Adding bot UI:

Added bot UI:

Show Welcome command interaction:

• Group Chat Scope Interactions:

Adding bot UI:

Added bot UI:

Show Welcome command interaction:

• Team Scope Interactions:

Adding bot UI:

Added bot UI:

Show Welcome command interaction:

2. MentionMe

• Result: The bot will respond to the message and mention the user

• Valid Scopes: personal, group chat, team chat

• Personal Scope Interactions:

MentionMe command interaction:

• Group Chat Scope Interactions:

MentionMe command interaction:

• Team Scope Interactions:

MentionMe command interaction:

3. MessageAllMembers

• Result: The bot will send a 1-on-1 message to each member in the current conversation (aka on the conversation's roster).

• Valid Scopes: personal, group chat, team chat

• Personal Scope Interactions:

MessageAllMembers command interaction:

• Group Chat Scope Interactions:

MessageAllMembers command interaction:

• Team Scope Interactions:

MessageAllMembers command interaction:

4. ImmersiveReader

• You can use the immersive reader property of adaptive cards by using the speak property. immersivereader command will send an adpative card in teams chat.

• Select the immersive reader option for running the speak property.

• A new screen will be open and the text will be read by default which is mentioned inside the speak property of adaptive card.

5. Message update events for user messages

• You will recieve event updates for message edit/delete features.

• Message is edited

• Message is soft-deleted

• Message is restored

You can select an option from the command list by typing @TeamsConversationBot into the compose message area and What can I do? text above the compose area.

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