page_type

description

products

languages

extensions

urlFragment

sample

This sample app demonstrates use of different bot conversation events available in bot framework v4 for 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 (Messages in bot conversations).

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.

GitHub Copilot Agent Mode

This sample is optimized for use with GitHub Copilot Agents and supports vibe coding workflows.

Follow the coding style and guidelines described in .github/copilot-instructions.md.
Use the stepwise development plan in sample-plan.md for modular feature delivery.
Run the bot locally with npm start.
Lint and test with npm run lint and npm test.
Use provided issue templates to create scoped tasks for Copilot Agents.

Agents can use CLI scripts and config files to help automate testing, linting, and deployment.

Included Features

Bots
Adaptive Cards
Teams Conversation Events
Immersive Reading Support for Cards
AI label
Citations
Feedback buttons
Sensitivity label

Interaction with bot

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Uploading must be enabled for your tenant, see steps here).

Teams Conversation Bot: Manifest

Prerequisites

Microsoft Teams is installed and you have an account
NodeJS
dev tunnel or ngrok latest version or equivalent tunnelling solution
Microsoft 365 Agents Toolkit for VS Code or TeamsFx CLI

Run the app (Using Microsoft 365 Agents Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Microsoft 365 Agents Toolkit for Visual Studio Code.

Ensure you have downloaded and installed Visual Studio Code
Install the Microsoft 365 Agents Toolkit extension
Select File > Open Folder in VS Code and choose this samples directory from the repo
Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
Select Debug > Start Debugging or F5 to run the app in a Teams web client.
In the browser that launches, select the Add button to install the app to Teams.

If you do not have permission to upload custom apps (uploading), Microsoft 365 Agents Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Run the app (Manually Uploading to Teams)

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.

Run ngrok - point to port 3978
```
ngrok http 3978 --host-header="localhost:3978"
```
Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:
```
devtunnel host -p 3978 --allow-anonymous
```

Register your app with Azure AD.

Register a new application in the Microsoft Entra ID – App Registrations portal.
Select New Registration and on the register an application page, set following values:
- Set name to your app name.
- Choose the supported account types (any account type will work)
- Leave Redirect URI empty.
- Choose Register.
On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You'll need those later when updating your Teams application manifest and in the appsettings.json.
Navigate to API Permissions, and make sure to add the follow permissions: Select Add a permission
- Select Add a permission
- Select Microsoft Graph -> Delegated permissions.
- User.Read (enabled by default)
- Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

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 Microsoft Entra ID 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 the tunneling application. Append with the path /api/messages

Setup for code

Clone the repository

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

In a terminal, navigate to samples/bot-conversation/nodejs
Install modules
```
npm install
```
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)

Run your bot at the command line:
```
npm start
```
This step is specific to Teams.
- Edit the manifest.json contained in the appManifest 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-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
- Zip up the contents of the appManifest 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)

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

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.

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:

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:

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.Read Receipt Check Read count

Result: The bot will check the count of members who have read your message which sent through MessageAllMembers. User can also reset the count using Reset read count command
Valid Scopes: personal, group chat, team chat
Group Chat Scope Interactions: Check Read count command interaction:

Reset Read count command interaction:

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.
A new screen will be open and the text will be read by default which is mentioned inside the speak property of adaptive card.

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

Format AI bot messages

Consists features such as citations, feedback buttons, and sensitivity label that enables better user engagement
AI label - enables user to identify that the message was generated using AI.
Citations - enables user to refer to the source of the bot's message through in-text citations and the reference.
Feedback buttons - enables user to provide positive or negative feedback based on their experience.

Sensitivity label - enables user to understand the confidentiality of the bot's message.
Send AI message - Replies back with a bot message containing all formats: AI label, Citations, Feedback buttons, and Sensitivity label.

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