Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The chatbot can also proactively reach out to users when it detects a need for their involvement, such as to notify them of new tasks to approve or if their account has become locked out. Suppose you have scenarios where you have to provide commands directly from Job, API, Workflows, or other system components to the Bot and send messages to users. In that case, you will be using the Proactive Messaging capability of the Bot. E.G., a job can trigger a message asking the user to approve a particular business request. In this doc, we will explore properties and a sample proactive message.

The BotProactiveMessageActivity allows you to send messages to any active bot conversation. Person.BotConversationReferenceID A conversation reference ID is required to proactively initiate a conversation with a user.

...

You can find the BotProactiveMessageActivity in the Activities toolbox in Workflow Studio. Simply drag and drop the activity into your workflow to use the activity in a workflow.

...

Anchor
Properties-for-BotProactiveMessageActivity
Properties-for-BotProactiveMessageActivity
Properties for BotProactiveMessageActivity

Property

Type

Description

BotTenantId

String

BotTenantId Specifies the Tenant ID. The administrator can retrieve the Bot Tenant ID of your organization from the Azure portal.

BotConversationReferenceId

Guid

Specifies the Conversation Reference ID of the user to whom you are sending the message(i.e., Person.BotConversationReferenceID)

message title

String

Specifies the subject of the message to show in the notification list. You can see the notification list by sending the bot the “nfs” command.

Message

String

Specifies the proactive message you want to send to a user.

MessageType

TheDotNetFactory.Framework.BotWF.Common.ProactiveMessageType

Specifies how the proactive message should be delivered to the user. The ProactiveMessageType is an enum with the following values:

  • ShowToUserImmediately – The user will receive and see the complete message immediately. You can use this type to send urgent messages.

  • NotificationReminder – The Message is delivered to the user’s notification list, and a Message Reminder is shown to remind the user to check the notification list.

  • NotificationOnly – The Message is delivered to the user’s notification list. There will be no additional action or any reminders.

MessageReminder

string

Text to show as a reminder to the user indicating that the user has received a message in the notification list.

CustomProactiveMessage

TheDotNetFactory.Framework.BotWF.Common.BotCapability

You may use this property to support the advanced handling of proactive messaging. You can find details of CustomProactiveMessage in the section.

...

  • BotAttachment

  • BotAttachmentPrompt

  • BotAttachmentData

  • BotChoicePrompt

  • BotHeroCard (Example below)

  • BotQuickChoicePrompt

  • BotTextMessage

  • BotTextPrompt

Anchor
Sample-Proactive-Message
Sample-Proactive-Message
Sample Proactive Message

...

Please follow the steps below to create a sample proactive message. You will be able to create a message and a hero card as shown in the output above for the following steps below.

...