Skip to content

Latest commit

 

History

History

python

README.md

page_type description products languages extensions urlFragment
sample
This app demonstrates using bot conversation events in Microsoft Teams, supporting adaptive cards, read receipts, and message update events. It includes immersive reader support for enhanced accessibility.
office-teams
office
office-365
python
contentType createdDate
samples
12-12-2019 13:38:25
officedev-microsoft-teams-samples-bot-conversation-python

Teams Conversation Bot

This sample app demonstrates how to handle various bot conversation events in Microsoft Teams, including read receipts and adaptive card interactions. It showcases capabilities such as immersive reader support and message update tracking, making it ideal for personal, group, and team chat scopes.

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.

Included Features

  • Bots
  • Adaptive Cards
  • Teams Conversation Events
  • Immersive Reading Support for Cards

Interaction with bot

BotConversation

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. (Sideloading must be enabled for your tenant, see steps here).

Teams Conversation Bot: Manifest

Prerequisites

  • Microsoft Teams is installed and you have an account
  • Python SDK min version 3.6
  • dev tunnel or ngrok latest version or equivalent tunnelling solution

Run the app (Using Teams Toolkit for Visual Studio Code)

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

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension and Python Extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Press CTRL+Shift+P to open the command box and enter Python: Create Environment to create and activate your desired virtual environment. Remember to select requirements.txt as dependencies to install when creating the virtual environment.
  5. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  6. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  7. 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 (sideloading), Teams 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.

  1. Clone the repository

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

  2. 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

  3. Create Azure Bot resource resource in Azure

    • Use the current https URL you were given by running the tunneling application. Append with the path /api/messages used by this sample
    • Ensure that you've enabled the Teams Channel
    • If you don't have an Azure account you can use this Azure free account here

  4. In a terminal, go to samples\bot-conversation

  5. Activate your desired virtual environment

  6. Install dependencies by running pip install -r requirements.txt in the project folder.

  7. Update the config.py 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.)

  8. 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 ${{AAD_APP_CLIENT_ID}} and ${{TEAMS_APP_ID}} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Zip up the contents of the appManifest folder to create a manifest.zip
    • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

  9. Run your bot with python app.py

Interacting with the bot

You can interact with this bot 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
  1. MentionMe
  • Result: The bot will respond to the message and mention the user
  • Valid Scopes: personal, group chat, team chat
  1. 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

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.

Running the sample

The bot initialization message Message

The bot will send the welcome card for you to interact with WelcomeCard

The bot will respond to the message and mention the user MentionMe

The bot initialization message MessageAllMembers

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