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.
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.
- Clone the repository
git clone https://github.com/Microsoft/botbuilder-samples.git- In a terminal, navigate to
botbuilder-samples\samples\python\16.proactive-messagesfolder - Activate your desired virtual environment
- In the terminal, type
pip install -r requirements.txt - Run your bot with
python app.py
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 TurnContext.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.
You may encounter permission-related errors when sending a proactive message. This can often be mitigated by using MicrosoftAppCredentials.TrustServiceUrl(). See the documentation for more information.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.