Get Conversation Members

An activity that gets the members of the specified conversation in Microsoft Azure Bot Service.


Get Conversation Members activity

Configure the Get Conversation Members activity

To configure the Get Conversation Members activity, do the procedure in this topic.

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library open the MS Azure Bot Service tab.

    Open MS Azure Bot Service tab
  3. On the MS Azure Bot Service tab, drag the Get Conversation activity onto your process.

    Drag Get Conversation activity

General Configuration

Specifies the basic settings for the Get Conversation Members activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

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

Get Conversation Members Configuration

Configures to get the conversation members.

Figure: Get Conversation Members Configuration screen

Get Conversation Members Configuration screen

Fields

Field NameDefinition

MS Azure Bot Service

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:

Create Add Token icon

Opens this Screen:
Access Token for Microsoft 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. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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 get the members.
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. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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?

Map Response to AgilePoint Schema

Function:
Specifies the connection from the bot API response parameter to your process schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

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

Default Value:
None
Example:
Refer to: