page_type | description | products | languages | extensions | urlFragment | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample app demonstrates use of different bot conversation events available in bot framework v4 for personal and teams scope. |
|
|
|
officedev-microsoft-teams-samples-bot-conversation-quickstart-js |
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.
- Bots
- Adaptive Cards
- Teams Conversation Events
Dependencies
- NodeJS
- ngrok or equivalent tunneling solution
- M365 developer account or access to a Teams account with the appropriate permissions to install an app.
-
Register a new application in the Azure Active Directory – App Registrations portal.
-
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 ngrok and append it with the path/api/messages
. It should like something workhttps://{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
-
Setup NGROK
- Run ngrok - point to port 3978
ngrok http 3978 --host-header="localhost:3978"
-
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
-
Update the
.env
configuration for the bot to use theBotId
andBotPassword
(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.) -
Setup Manifest for Teams
- This step is specific to Teams.
- Edit the
manifest.json
contained in theappPackage/
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 themanifest.json
) - Zip up the contents of the
appPackage/
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the left-bottom Apps view, click "Upload a custom app")
- Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
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.