Bot Framework v4 proactive messages bot sample.
This bot has been created using Bot Framework, it shows how to send proactive messages to users by capturing a conversation reference, then using it later to initialize outbound messages.
This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.
Typically, each message that a bot sends to the user directly relates to the user's prior input. In some cases, a bot may need to send the user a message that is not directly related to the current topic of conversation. These types of messages are called proactive messages.
Proactive messages can be useful in a variety of scenarios. If a bot sets a timer or reminder, it will need to notify the user when the time arrives. Or, if a bot receives a notification from an external system, it may need to communicate that information to the user immediately. For example, if the user has previously asked the bot to monitor the price of a product, the bot can alert the user if the price of the product has dropped by 20%. Or, if a bot requires some time to compile a response to the user's question, it may inform the user of the delay and allow the conversation to continue in the meantime. When the bot finishes compiling the response to the question, it will share that information with the user.
This project has a notify endpoint that will trigger the proactive messages to be sent to all users who have previously messaged the bot.
- From the root of this project folder:
- Build the sample using
mvn package - Run it by using
java -jar .\target\bot-proactive-sample.jar
- Build the sample using
Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.
- Install the latest Bot Framework Emulator from here
- Launch Bot Framework Emulator
- File -> Open Bot
- Enter a Bot URL of
http://localhost:3978/api/messages
With the Bot Framework Emulator connected to your running bot, the sample will not respond to an HTTP GET that will trigger a proactive message. The proactive message can be triggered from the command line using curl or similar tooling, or can be triggered by opening a browser windows and navigating to http://localhost:3978/api/notify.
-
Send a get request to
http://localhost:3978/api/notifyto proactively message users from the bot.curl get http://localhost:3978/api/notify
-
Using the Bot Framework Emulator, notice a message was proactively sent to the user from the bot.
- Launch a web browser
- Navigate to
http://localhost:3978/api/notify - Using the Bot Framework Emulator, notice a message was proactively sent to the user from the bot.
In addition to responding to incoming messages, bots are frequently called on to send "proactive" messages based on activity, scheduled tasks, or external events.
In order to send a proactive message using Bot Framework, the bot must first capture a conversation reference from an incoming message using activity.getConversationReference(). This reference can be stored for later use.
To send proactive messages, acquire a conversation reference, then use adapter.continueConversation() to create a TurnContext object that will allow the bot to deliver the new outgoing message.
As described on Deploy your bot, you will perform the first 4 steps to setup the Azure app, then deploy the code using the azure-webapp Maven plugin.
From a command (or PowerShell) prompt in the root of the bot folder, execute:
az login
az account set --subscription "<azure-subscription>"
If you aren't sure which subscription to use for deploying the bot, you can view the list of subscriptions for your account by using az account list command.
az ad app create --display-name "<botname>" --password "<appsecret>" --available-to-other-tenants
Replace <botname> and <appsecret> with your own values.
<botname> is the unique name of your bot.
<appsecret> is a minimum 16 character password for your bot.
Record the appid from the returned JSON
Replace the values for <appid>, <appsecret>, <botname>, and <groupname> in the following commands:
az deployment sub create --name "proactiveBotDeploy" --location "westus" --template-file ".\deploymentTemplates\template-with-new-rg.json" --parameters appId="<appid>" appSecret="<appsecret>" botId="<botname>" botSku=S1 newAppServicePlanName="proactiveBotPlan" newWebAppName="proactiveBot" groupLocation="westus" newAppServicePlanLocation="westus"
az deployment group create --resource-group "<groupname>" --template-file ".\deploymentTemplates\template-with-preexisting-rg.json" --parameters appId="<appid>" appSecret="<appsecret>" botId="<botname>" newWebAppName="proactiveBot" newAppServicePlanName="proactiveBotPlan" appServicePlanLocation="westus" --name "proactiveBot"
In src/main/resources/application.properties update
MicrosoftAppPasswordwith the botsecret valueMicrosoftAppIdwith the appid from the first step
- Execute
mvn clean package - Execute
mvn azure-webapp:deploy -Dgroupname="<groupname>" -Dbotname="<bot-app-service-name>"
If the deployment is successful, you will be able to test it via "Test in Web Chat" from the Azure Portal using the "Bot Channel Registration" for the bot.
After the bot is deployed, you only need to execute #6 if you make changes to the bot.
- Spring Boot
- Maven Plugin for Azure App Service
- Bot Basics
- Send proactive messages
- continueConversation Method
- getConversationReference Method
- Activity processing
- Azure Bot Service Introduction
- Azure Bot Service Documentation
- Azure CLI
- Azure Portal
- Azure for Java cloud developers
- Channels and Bot Connector Service