README.md

Teams Messaging Extensions Action

Messaging Extensions are a special kind of Microsoft Teams application that is support 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.

Prerequisites

• Microsoft Teams is installed and you have an account
• Python SDK version 3.7
• ngrok or equivalent tunnelling solution

To try this sample

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/Microsoft/botbuilder-samples.git

2. Run ngrok - point to port 3978

   ngrok http -host-header=rewrite 3978

3. Create Bot Framework registration resource in Azure

   • Use the current https URL you were given by running ngrok. 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 Bot Framework registration

4. Bring up a terminal, navigate to botbuilder-samples\samples\python\51.teams-messaging-extensions-action folder

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 teamsAppManifest 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)
   • Zip up the contents of the teamsAppManifest 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 in Teams

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. Also note this bot does not process incoming Messages, but responds only to Messaging Extension commands.

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.

or

2. Selecting the Share Message command from the Message command list.

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