Name		Name	Last commit message	Last commit date
parent directory ..
.vscode		.vscode
Images		Images
appManifest		appManifest
assets		assets
demo-manifest		demo-manifest
env		env
infra		infra
.env		.env
.gitignore		.gitignore
README.md		README.md
botActivityHandler.js		botActivityHandler.js
build.js		build.js
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json
teamsapp.local.yml		teamsapp.local.yml
teamsapp.yml		teamsapp.yml

README.md

page_type

description

products

languages

extensions

urlFragment

sample

Hello world Messaging Extension that accepts search requests and returns results.

office-teams

office

office-365

javascript

nodejs

contentType	createdDate
samples	07/07/2021 01:38:27 PM

officedev-microsoft-teams-samples-msgext-search-quickstart-js

Messaging Extension quick start

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
Message Extensions
Search Commands

Interaction with app

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

Messaging Extension quick start: Manifest

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

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

Setup

Register a new application in the Microsoft Entra ID – App Registrations portal.
Azure Bot [Azure Bot] (https://learn.microsoft.com/azure/bot-service/abs-quickstart?view=azure-bot-service-4.0&tabs=userassigned)

For the Messaging endpoint URL, use the current https URL you were given by running the tunnelling application and append it with the path /api/messages. It should like something work https://{subdomain}.ngrok-free.app/api/messages.
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

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
```

Setup for code

Clone the repository

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

In a terminal, navigate to samples/msgext-search-quickstart/js
Update the .env configuration for the bot to use the MicrosoftAppId and MicrosoftAppPassword, BaseUrl with application base url. For e.g., your ngrok or dev tunnels url. (Note the MicrosoftAppId is the AppId created in step 1 (Setup for Bot), the MicrosoftAppPassword is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.)
Run your app
```
npm start
```

Setup Manifest for Teams

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 app registration earlier) everywhere you see the place holder string {{Microsoft-App-Id}} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
- Edit the manifest.json for validDomains and replace {{domain-name}} with base Url of your domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
- Zip up the contents of the appManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
- Go to Microsoft Teams. From the lower left corner, select Apps
- From the lower left corner, choose Upload a custom App
- Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.