Bots/Messaging Extension

Browse code

Bots allow users to interact with your web service through text, interactive cards, and task modules. Messaging extensions allow users to interact with your web service through buttons and forms in the Microsoft Teams client. They can search, or initiate actions, in an external system from the compose message area, the command box, or directly from a message.

Included Features

• Bots
• Adaptive Cards
• Teams Conversation Events

Interaction with app

Prerequisites

Dependencies

• NodeJS
• dev tunnel or ngrok latest version or equivalent tunneling solution
• M365 developer account or access to a Teams account with the appropriate permissions to install an app.
• Teams Toolkit for VS Code or TeamsFx CLI

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
3. Select File > Open Folder in VS Code and choose this samples directory from the repo
4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
6. 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)

1. Register a new application in the Microsoft Entra ID – App Registrations portal.

2. Setup for Bot In Azure portal, create a Bot Framework registration resource.

   • Ensure that you've enabled the Teams Channel
   • For the Messaging endpoint URL, use the current https URL you were given by running the tunneling application and append it with the path /api/messages. It should like something work https://{subdomain}.ngrok-free.app/api/messages.

NOTE: When you create your bot you will create an App ID and App password - make sure you keep these for later.

• Click on the Bots menu item from the toolkit and select the bot you are using for this project. Update the messaging endpoint and press enter to save the value in the Bot Framework.

• Ensure that you've enabled the Teams Channel

3. Setup NGROK

• 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
  

4. Setup for code

• Clone the repository

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

• In a terminal, navigate to samples/bot-conversation-quickstart/js

• Build

  npm install

• Run your app

  npm start

5. Update the .env configuration for the bot to use the BotId and BotPassword (Note the BotId is the AppId created in step 1 (Setup for Bot), the BotPassword is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.)

6. Setup Manifest for Teams

• This step is specific to Teams.
  • Edit the manifest.json contained in the appManifest/ folder to replace with your MicrosoftAppId (that was created in step1.1 and is the same value of MicrosoftAppId in .env file) everywhere you see the place holder string {MicrosoftAppId} (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 left-bottom Apps view, click "Upload a custom app")

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

Running the sample

Deploy to Teams (Visual Studio Toolkit Only)

Start debugging the project by hitting the F5 key or click the debug icon in Visual Studio Code and click the Start Debugging green arrow button.