Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 4.02 KB

README.md

File metadata and controls

71 lines (48 loc) · 4.02 KB
Raw

Message Reactions Bot

Bot Framework v4 core bot sample.

Bot Framework message reactions bot sample.

This bot has been created using Bot Framework, it shows how to create a simple bot that responds to Message Reactions.

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

Prerequisites

  • Java 1.8+
  • Install Maven
  • An account on Azure if you want to deploy to Azure.
  • Microsoft Teams is installed and you have an account
  • ngrok or equivalent tunnelling solution

To try this sample

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.

  1. Clone the repository

    git clone https://github.com/Microsoft/botbuilder-java.git

  2. Run ngrok - point to port 3978

    ngrok http -host-header=rewrite 3978

  3. Create Bot Framework registration resource in Azure

  4. Update the resources/application.properties 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.)

  5. This step is specific to Teams.

    • Edit the manifest.json contained in the teamsAppManifest 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 the manifest.json). Note: the Task Modules containing pages will require the deployed bot's domain in validDomains of the manifest.
    • Zip up the contents of the teamsAppManifest folder to create a manifest.zip
    • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

  6. From the root of this project folder:

    • Build the sample using mvn package
    • Unless done previously, install the packages in the local cache by using mvn install
    • Run it by using java -jar .\target\bot-messagereaction-sample.jar

Connect to the bot using Bot Framework Emulator

  • Launch Bot Framework Emulator
  • File -> Open Bot
  • Enter a Bot URL of http://localhost:3978/api/messages

Interacting with the bot in Teams

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.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading