Send Message To Conversation

An activity that sends a message to the specified conversation in Microsoft Azure Bot Service.


Send Message To Conversation activity

Configure the Send Message To Conversation activity

To configure the Send Message To Conversation activity, do the procedure in this topic.

Examples

Prerequisites

Good to Know

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library open the Bot Integration Bot Integration icon tab.
      2. On the Bot Integration Bot Integration icon tab, drag the Send Message To Conversation Send Message To Conversation icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Send Message To Conversation activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Send Message To Conversation Configuration

Configures the message to send to conversation.

Figure: Send Message To Conversation Configuration screen

Send Message To Conversation Configuration screen

Fields

Field Name Definition

Azure Bot Services

Function:
Specifies the access token that connects to your Microsoft Azure Bot Service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:

Add Token Add Token icon

Opens this Screen:
Access Token for Azure Bot Service
Function of this Screen:
Configure an access token to connect to Microsoft Azure Bot Service.
Example:

Service URL

Function:
Specifies the URL for your bot.
Accepted Values:
A valid bot URL.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Conversation ID

Function:
Specifies the conversation ID for which to send the message.
Accepted Values:
A valid conversation ID.

When you create a conversation in your bot, you get the conversation ID for each conversation.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Attachment Types

Function:
Specifies the type of attachment to include in your message.
Accepted Values:
  • Add media attachments to messages - Adds media files to your message.
  • Add rich card attachments to messages - Adds rich cards to your message.
  • Add suggested actions to messages - Adds suggested actions to apply to your message.
Default Value:
None
Accepts Process Data Variables:
No

Request Mapping

Function:
Connects the bot API request parameter to your schema. This is mandatory only if the request passes data from the process schema to parameters in the bot API.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the request to the data model for your process.

Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Store Response Activity ID in this Variable

Function:
Specifies the process data variable that stores your message ID from Microsoft Azure Bot Service.
Accepted Values:
A process data variable that accepts an alphanumeric string with no spaces or special characters.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?