Audio Card Attachment

An activity that creates an audio card attachment for a bot message in Microsoft Azure Bot Service.

Configure the Audio Card Attachment activity

To configure the Audio Card Attachment activity, do the procedure in this topic.

Examples

(Example) How to Get the Access Token Credentials from Microsoft Azure Bot Service

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library open the MS Azure Bot Service tab.
On the MS Azure Bot Service tab, drag the Audio Card Attachment activity onto your process.

General Configuration

Specifies the basic settings for the Audio Card Attachment activity.

Good to Know

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

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts 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	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

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

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Audio Card Attachment Configuration > Basic

Configures the basic information for a audio card.

Fields

Field Name	Definition
MS Azure Bot Service	Description: Specifies the access token that connects to your Microsoft Azure Bot Service. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: (Example) How to Get the Access Token Credentials from Microsoft Azure Bot Service
Create	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: (Example) How to Get the Access Token Credentials from Microsoft Azure Bot Service
Service URL	Description: Specifies the URL for your bot. Allowed Values: A valid bot URL. Default Value: None Accepts 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	Description: Specifies the conversation ID for which to send the message. Allowed 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 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?
From ID	Description: Specifies the ID for your bot. Allowed Values: A valid bot ID. Default Value: None Accepts 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?
From Name	Description: Specifies the name for your bot. Allowed Values: A valid bot name. Default Value: None Accepts Variables: Yes
Recipient ID	Description: Specifies the user ID of the channel to associate with the action. Allowed Values: A valid user ID of the channel. Default Value: None Accepts 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?
Recipient Name	Description: Specifies the user name to associate with the action.. Allowed Values: A valid user name. Default Value: None Accepts Variables: Yes
Message	Description: Specifies the content of the message. Allowed Values: More than one line of text. Default Value: None Accepts Variables: Yes

Audio Card Attachment Configuration > Card Config tab

Configures the audio card.

Fields

Field Name	Definition
Title	Description: Specifies the title for your card. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: Yes
Subtitle	Description: Specifies the subtitle for your card. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: Yes
Description	Description: Specifies an optional text description for the card. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No
Audio URL	Description: Specifies the URL of an audio file to use in your card for the message. Allowed Values: A valid URL to an audio file. Default Value: None Accepts Variables: Yes
Audio Thumbnail URL	Description: Specifies the URL that points to a thumbnail image to use for a audio content. Allowed Values: A URL for an image. Default Value: None Accepts Variables: Yes
Inline Action Buttons / Map Action Buttons from schema	Description: Specifies whether to use action buttons on your card with literal values. Allowed Values: Inline Action Buttons - Lets you specify action buttons on your card with literal (hard coded) values. Map Action Buttons from schema - Lets you specify action buttons on your card with repeating schema elements. Default Value: None
Button Text	Description: Specifies a name for the button. To Open this Field: On the Card Config tab, click Inline Action Buttons. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None
Action to Perform	Description: Specifies what the button does. To Open this Field: On the Card Config tab, click Inline Action Buttons. Allowed Values: Open URL - Opens a specified URL in a web browser. Download File - Opens a file at a specified URL. IM Back - Sends specified text to send to the bot. Message Back - Sends a specified message to the bot. Post Back - Sends a specified post to the bot. Show Image - Shows an image from a specified URL. Sign In - Specifies the URL for an OAuth 2.0 sign-in procedure. Play Audio - Plays an audio file from a specified URL. Play Video - Plays a video file from a specified URL. Default Value: None
Value	Description: Specifies the value for your action. To Open this Field: On the Card Config tab, click Inline Action Buttons. Allowed Values: The value of this field depends on the action type you select in the Action to Perform list. Default Value: None 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?
Add	Function: Adds a button for action. To Open this Field: On the Card Config tab, click Inline Action Buttons.
Select the repeating data node that will contain the Buttons data	Description: Specifies a repeating schema element that stores the data for your buttons. To Open this Field: On the Card Config tab, click Map Action Buttons from schema. Allowed Values: A valid repeating schema element. Default Value: None Accepts Variables: Yes