page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample app demonstrate how to use Messaging Extensions Search |
|
|
|
officedev-microsoft-teams-samples-bot-message-extension-python |
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 a Search-based Messaging Extension.
- Bots
- Message Extensions
- Search Commands
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 Messaging Extensions Search: Manifest
- Microsoft Teams is installed and you have an account
- Python SDK version 3.7
- ngrok or equivalent tunnelling solution
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.
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
Run ngrok - point to port 3978
ngrok http 3978 --host-header="localhost:3978"
-
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
- Use the current
-
Bring up a terminal, navigate to
Microsoft-Teams-Samples\samples\msgext-search\python
folder -
Activate your desired virtual environment
-
Install dependencies by running
pip install -r requirements.txt
in the project folder. -
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.) -
This step is specific to Teams.
- Edit the
manifest.json
contained in theteamsAppManifest
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 themanifest.json
) - Zip up the contents of the
teamsAppManifest
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the Apps view click "Upload a custom app")
- Edit the
-
Run your bot with
python app.py
Note this
manifest.json
specified that the feature will be available from both thecompose
andcommandBox
areas of Teams. Please refer to Teams documentation for more details.
In Teams, the command bar is located at the top of the window. When you at mention the bot what you type is forwarded (as you type) to the bot for processing. By way of illustration, this sample uses the text it receives to query the NuGet package store.
There is a secondary, drill down, event illustrated in this sample: clicking on the results from the initial query will result in the bot receiving another event.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.