Skip to content

How to configure Message Extension capability within your Teams app

Jump to bottom
yukun-dong edited this page Feb 15, 2023 · 26 revisions

Configure Message Extension capability within your Teams app

Introduction

Message Extension allows users to interact with your web service while composing messages in the Microsoft Teams client. Users can invoke your web service to assist message composition, from the message compose box, or from the search bar.

Message Extensions are implemented on top of the Bot support architecture within Teams. Learn more from Build message extensions for Teams .

Prerequisites

To configure message extension as additional capability, please make sure:

  • You have a Teams application and its manifest.
  • You have a Microsoft 365 account to test the application.

For adding message extension to a tab Teams app, please go to: Add message extension to a tab Teams app.

For adding message extension to a bot Teams app, please go to: Add message extension to a bot Teams app.

Add message extension to a tab Teams app:

Following are the steps to add Message Extension capability to a tab app:

  1. Create a message extension Teams app using Teams Toolkit.
  2. Update manifest file.
  3. Bring message extension code to your project.
  4. Setup local debug environment.
  5. Move the application to Azure.

Create a message extension app using Teams Toolkit

Please check the guide Create a message extension app with Teams Toolkit

Configure Message Extension capability in Teams application manifest

  1. You can configure message extension in appPackage/manifest.json. You can also refer to message extension schema if you want to customize.

    Example:

     "composeExtensions": [
    {
        "botId": "${{BOT_ID}}",
        "commands": [
            {
                "id": "createCard",
                "context": [
                    "compose"
                ],
                "description": "Command to run action to create a Card from Compose Box",
                "title": "Create Card",
                "type": "action",
                "parameters": [
                    {
                        "name": "title",
                        "title": "Card title",
                        "description": "Title for the card",
                        "inputType": "text"
                    },
                    {
                        "name": "subTitle",
                        "title": "Subtitle",
                        "description": "Subtitle for the card",
                        "inputType": "text"
                    },
                    {
                        "name": "text",
                        "title": "Text",
                        "description": "Text for the card",
                        "inputType": "textarea"
                    }
                ]
            },
            {
                "id": "shareMessage",
                "context": [
                    "message"
                ],
                "description": "Test command to run action on message context (message sharing)",
                "title": "Share Message",
                "type": "action",
                "parameters": [
                    {
                        "name": "includeImage",
                        "title": "Include Image",
                        "description": "Include image in Hero Card",
                        "inputType": "toggle"
                    }
                ]
            },
            {
                "id": "searchQuery",
                "context": [
                    "compose",
                    "commandBox"
                ],
                "description": "Test command to run query",
                "title": "Search",
                "type": "query",
                "parameters": [
                    {
                        "name": "searchQuery",
                        "title": "Search Query",
                        "description": "Your search query",
                        "inputType": "text"
                    }
                ]
            }
        ],
        "messageHandlers": [
            {
                "type": "link",
                "value": {
                    "domains": [
                        "*.botframework.com"
                    ]
                }
            }
        ]
    }
]

  2. Add your bot domain to the validDomains field. Example:

    "validDomains": [
    "${{BOT_DOMAIN}}"
],

    BOT_ID and BOT_DOMAIN are built-in variables of Teams Toolkit. They will be replaced with the true value in runtime based on your current environment(local, dev, etc.).

Bring message extension code to your project

  1. Bring your own message extension app code into your project. If you don't have one, you can use the message extension app project previously created and copy the source code to into your current project. We suggest you to copy them into a bot/ folder. Your folder structure will be like: 
    |-- .vscode/
|-- appPackage/
|-- env/
|-- infra/
|-- public/
|-- bot/           <!--message extension source code-->
|   |-- index.ts
|   |-- config.ts
|   |-- teamsBot.ts
|   |-- package.json
|-- src/            <!--your current source code-->
|   |-- index.ts
|-- package.json
|-- teamsapp.local.yml
|-- teamsapp.yml
    We suggest you to re-organize the folder structure and create a root package.json as: 
    |-- .vscode/
|-- appPackage/
|-- env/
|-- infra/
|-- bot/            <!--message extension source code-->
|   |-- index.ts
|   |-- config.ts
|   |-- teamsBot.ts
|   |-- package.json
|-- tab/           <!--move your current source code to a new sub folder-->
|   |-- public/
|   |-- src/
|   |   |-- index.tsx
|   |-- package.json
|-- package.json <!--root package.json-->
|-- teamsapp.local.yml
|-- teamsapp.yml
  2. Add following to your root package.json: 
    "scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "install:bot": "cd bot && npm install",
  "install:tab": "cd tab && npm install",
  "install": "concurrently \"npm run install:bot\" \"npm run install:tab\"",
  "dev:bot": "cd bot && npm run dev",
  "start:tab": "cd tab && npm run start",
  "build:tab": "cd tab && npm run build",
  "build:bot": "cd bot && npm run build",
  "build": "concurrently \"npm run build:tab\" \"npm run build:bot\""
},
"devDependencies": {
    "@microsoft/teamsfx-run-utils": "alpha"
},
"dependencies": {
    "concurrently": "^7.6.0"
},

Setup local debug environment

  1. Manually merge the content in .vscode/ and teamsapp.local.yml folders with yours. Update the teamsapp.local.yml to target your message extension code. Here is an sample project for reference.

  2. Open the Run and Debug Activity Panel and select Debug (Edge) or Debug (Chrome). Press F5 to preview your Teams app locally.

Move the application to Azure

  1. Manually merge the content in infra/ and teamsapp.yml folder with yours. Here is an sample project for reference.

  2. Run Teams: Provision in the cloud command in Visual Studio Code to apply the bicep to Azure.

  3. Run Teams: Deploy to cloud command in Visual Studio Code to deploy your app code to Azure.

  4. Open the Run and Debug Activity Panel and select Launch Remote (Edge) or Launch Remote (Chrome). Press F5 to preview your Teams app.

Add message extension to a bot Teams app:

Since message extensions are implemented on top of the Bot support architecture within Teams, adding Message Extension to a bot Teams app is simpler than adding to a tab Teams app.

Following are the steps to add Message Extension capability to a bot app:

  1. Create a message extension Teams app using Teams Toolkit.
  2. Update manifest file.
  3. Bring message extension code to your project.

Create a message extension app using Teams Toolkit

Please check the guide Create a message extension app with Teams Toolkit

Configure Message Extension capability in Teams application manifest

  1. You can configure message extension in appPackage/manifest.json. You can also refer to message extension schema if you want to customize.

    Example:

     "composeExtensions": [
    {
        "botId": "${{BOT_ID}}",
        "commands": [
            {
                "id": "createCard",
                "context": [
                    "compose"
                ],
                "description": "Command to run action to create a Card from Compose Box",
                "title": "Create Card",
                "type": "action",
                "parameters": [
                    {
                        "name": "title",
                        "title": "Card title",
                        "description": "Title for the card",
                        "inputType": "text"
                    },
                    {
                        "name": "subTitle",
                        "title": "Subtitle",
                        "description": "Subtitle for the card",
                        "inputType": "text"
                    },
                    {
                        "name": "text",
                        "title": "Text",
                        "description": "Text for the card",
                        "inputType": "textarea"
                    }
                ]
            },
            {
                "id": "shareMessage",
                "context": [
                    "message"
                ],
                "description": "Test command to run action on message context (message sharing)",
                "title": "Share Message",
                "type": "action",
                "parameters": [
                    {
                        "name": "includeImage",
                        "title": "Include Image",
                        "description": "Include image in Hero Card",
                        "inputType": "toggle"
                    }
                ]
            },
            {
                "id": "searchQuery",
                "context": [
                    "compose",
                    "commandBox"
                ],
                "description": "Test command to run query",
                "title": "Search",
                "type": "query",
                "parameters": [
                    {
                        "name": "searchQuery",
                        "title": "Search Query",
                        "description": "Your search query",
                        "inputType": "text"
                    }
                ]
            }
        ],
        "messageHandlers": [
            {
                "type": "link",
                "value": {
                    "domains": [
                        "*.botframework.com"
                    ]
                }
            }
        ]
    }
]

  2. Add your bot domain to the validDomains field. Example:

    "validDomains": [
    "${{BOT_DOMAIN}}"
],

    BOT_ID and BOT_DOMAIN are built-in variables of Teams Toolkit. They will be replaced with the true value in runtime based on your current environment(local, dev, etc.).

Bring message extension code to your project

  1. If you are adding message extension to a bot Teams app, then you should already have a class that extends TeamsActivityHandler. Bring your own message extension functions, or copy functions from your previously created message extension app to your own class. Below is an example if you copy functions from Teams Toolkit created message extension app:

      public class YourHandler extends TeamsActivityHandler{
    /**
     * your own code
    */

    //message extension code
    // Action.
    public async handleTeamsMessagingExtensionSubmitAction(
    context: TurnContext,
    action: any
  ): Promise<any> {}

    // Search.
    public async handleTeamsMessagingExtensionQuery(context: TurnContext, query: any): Promise<any> {}

    public async handleTeamsMessagingExtensionSelectItem(
      context: TurnContext,
      obj: any
    ): Promise<any> {}

    // Link Unfurling.
    public async handleTeamsAppBasedLinkQuery(context: TurnContext, query: any): Promise<any> {}
  }


    async function createCardCommand(context: TurnContext, action: MessagingExtensionAction): Promise<MessagingExtensionResponse> {
  }

    async function shareMessageCommand(context: TurnContext, action: MessagingExtensionAction): Promise<MessagingExtensionResponse> {
  }

What’s next

There are other commonly suggested next steps, for example:

Build Apps for Microsoft Teams | Build or Extend Microsoft Copilot for Microsoft 365 | Microsoft 365 Platform Blogs | Microsoft 365 Developer YouTube Channel

Build Custom Engine Copilots

Scenario-based Tutorials

Extend your app across Microsoft 365

App settings and Microsoft Entra Apps

Configure multiple capabilities

Add Authentication to your app

Connect to cloud resources

Deploy apps to production

Clone this wiki locally