Get Conversation Attribute action

AI-generated summary

Genesys Cloud's Get Conversation Attribute action retrieves existing conversation attribute records, enabling flows to reference and reuse previously captured custom data about conversations according to defined schemas. The action requires configuration of four primary fields: a distinctive Name for display in the task sequence, a valid Conversation ID (UUID) for Workflow-type flows, a Schema selection from previously created conversation schemas to define record structure, and a Record ID specifying the unique identifier of the attribute record to retrieve. A Result field assigns a variable name to the retrieved record for subsequent flow processing. The action supports multiple data types including Boolean, Date, Integer, Number, String, and Queue types, with output data accessible using dot notation for complex JSON structures. Execution implements three primary paths: a Found path that populates the Result field when the conversation attribute record is successfully located, a Not Found path that executes when no matching record exists without populating the Result field, and a Failure path that triggers when action completion errors or processing problems occur. Failure path configuration includes failure output mapping for errorType (a nonempty string containing the error category) and errorMessage (a non-localized failure message). The action supports three errorType values: ActionInvocationLimitExceeded (triggered after five successful invocations within a flow), ConversationCustomAttributeRecordNotFound (when attempting to fetch non-existent records), and GeneralError (for general retrieval failures). Users can assign variables to failure data values and configure appropriate actions for each path outcome to manage flow behavior based on success or failure conditions. Usage is metered based on API invocations with rule-based decision pricing applied. Error handling encompasses GeneralExecutionError and InvalidRequest types, with retry functionality recommended for execution errors during non-peak periods to enhance flow resiliency.

Use the Get Conversation Attribute action to retrieve an existing conversation attribute record. This action lets the flow reference previously captured custom data about the conversation and present it in alignment with the schema, creating further reuse opportunities.

Configure the Get Conversation Attribute action

Field	Description
Name	Type a distinctive name for the Get Conversation Attribute action. The label you enter here becomes the action’s name displayed in the task sequence.
Conversation ID	Enter the valid UUID of the conversation that contains the record you want to retrieve. Note: This field is applicable only for Workflow type flows.
Schema	Click the arrow at the end of this list and select a previously created conversation schema that represents the record you want to retrieve. To narrow the selection, type the first few letters of the schema name.
Record ID	Enter the unique ID of the conversation attribute record that you want to retrieve.
Result	Assign a variable name to the retrieved conversation attribute record for further use in the flow.

Define failure outputs

Field	Description
Failure Outputs	These outputs allow the flow author to map the results of any resulting errorType and errorMessage variables when the Get Conversation Attribute action takes the failure path. The failure outputs help you anticipate potential issues and manage them effectively, improving your flow’s resiliency. errorType: A nonempty string that contains the type or category of the error. errorMessage: A non-localized failure message. The string can be empty or NOT_SET. Note: Hover over the information icon next to errorType to display the list of allowable errorType values. Select the variables that you want to assign to the failure data values returned by the Get Conversation Attribute action. You can use the following errorType values: ActionInvocationLimitExceeded: If a flow has successfully run the Get Conversation Attribute action five times, any subsequent invocations of the action take the failure path. ConversationCustomAttributeRecordNotFound: Occurs if you attempt to fetch a record that does not exist. GeneralError: If there is a general error when retrieving the conversation attribute record, the action takes the failure path. Note: Click the arrow next to Failure Outputs and expand or collapse the list of variables.

Field

Description

Failure Outputs

These outputs allow the flow author to map the results of any resulting errorType and errorMessage variables when the Get Conversation Attribute action takes the failure path. The failure outputs help you anticipate potential issues and manage them effectively, improving your flow’s resiliency.

errorType: A nonempty string that contains the type or category of the error.
errorMessage: A non-localized failure message. The string can be empty or NOT_SET.

Note: Hover over the information icon next to errorType to display the list of allowable errorType values.

Select the variables that you want to assign to the failure data values returned by the Get Conversation Attribute action.

You can use the following errorType values:

ActionInvocationLimitExceeded: If a flow has successfully run the Get Conversation Attribute action five times, any subsequent invocations of the action take the failure path.
ConversationCustomAttributeRecordNotFound: Occurs if you attempt to fetch a record that does not exist.
GeneralError: If there is a general error when retrieving the conversation attribute record, the action takes the failure path.

Note: Click the arrow next to Failure Outputs and expand or collapse the list of variables.

Configure found and not found paths

Path	Description
Found	A Found path indicates that Architect has located the conversation attribute record. Drag the appropriate action below this path. Note: The Result field only populates when the flow follows the Found path.
Not Found	A Not Found path indicates that Architect did not find the matching conversation attribute record. Drag the appropriate action below this path. Note: The Result field does not populate when the flow follows the Not Found path.

Path

Description

Found

A Found path indicates that Architect has located the conversation attribute record. Drag the appropriate action below this path.

Note: The Result field only populates when the flow follows the Found path.

Not Found

A Not Found path indicates that Architect did not find the matching conversation attribute record. Drag the appropriate action below this path.

Note: The Result field does not populate when the flow follows the Not Found path.

[NEXT] Was this article helpful?

Get user feedback about articles.