page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample showcases feature on how to capture reaction events when reactions are passed to the bot through personal/teams messages. |
|
|
|
officedev-microsoft-teams-samples-bot-message-reaction-nodejs |
Message the bot and it will respond with an 'Echo: [your message]'. Add a message reaction to the bot's response, and the bot will reply accordingly.
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 Message Reactions Bot: Manifest
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.
-
Run ngrok - point to port 3978
ngrok http --host-header=rewrite 3978
In Azure portal, create a Azure Bot resource. - For bot handle, make up a name. - Select "Use existing app registration" (Create the app registration in Azure Active Directory beforehand.) - If you don't have an Azure account create an Azure free account here
In the new Azure Bot resource in the Portal,
- Ensure that you've enabled the Teams Channel
- In Settings/Configuration/Messaging endpoint, enter the current https
URL you were given by running ngrok. Append with the path /api/messages
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In a terminal, navigate to
samples/bot-message-reaction/nodejs
-
Install modules
npm install
-
Update the
.env
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.)MicrosoftAppTenantId
will be the id for the tenant where application is registered.
- Also, set MicrosoftAppType in the
.env
. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)
-
Run your bot at the command line:
npm start
-
This step is specific to Teams.
- Edit the
manifest.json
contained in theappPackage
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
) - Edit the
manifest.json
forvalidDomains
with base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok.io
then your domain-name will be1234.ngrok.io
. - Zip up the contents of the
appPackage
folder to create amanifest.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 Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.) - Add the app in personal/groupchat/team scope (supported scopes)
- Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
Message the bot and it will respond with an 'Echo: [your message]'. Add a message reaction to the bots response, and the bot will reply accordingly.
- Personal Scope Interactions:
- Group Chat Scope Interactions:
- Team Scope Interactions:
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.