Get Conversation Attributes action

AI-generated summary

Genesys Cloud's Get Conversation Attributes action retrieves multiple existing conversation attribute records, enabling flows to reference previously captured custom data and present it according to each record's schema for enhanced reuse opportunities. The action requires configuration of four primary fields: a distinctive Name for display in the task sequence, a valid Conversation ID (UUID) containing the target records, a Schema selection from previously created conversation schemas to define record structure, and Record IDs specifying which conversation attribute records to retrieve. Retrieved records are assigned to a collection variable designated in the Result field for subsequent flow processing. The system supports dual input configuration modes—standard mode with predefined fields and JSON mode with direct property editing—both accepting literal and expression input values. Data types supported include Boolean, Date, Integer, Number, String, and Queue types, with complex JSON structures restricted to expression mode once switched. Users manage configuration through the arrow interface and can leverage an information icon tooltip to access allowable parameter values. Error handling defines multiple outcome paths based on retrieval results. The Found path indicates all requested records were located with the Result field populated. The Partially Found path occurs when some records are located or schema mismatches occur, with unfound records appearing as NOT_SET and the Result field populated. The Not Found path indicates no matching records were identified with the Result field unpopulated. The Failure path triggers on action completion errors or processing problems and includes configurable failure outputs mapping errorType and errorMessage variables, enabling flow authors to anticipate potential issues and improve flow resiliency. The action supports three errorType values: ActionInvocationLimitExceeded (triggered after five successful invocations), ConversationCustomAttributeRecordNotFound (when requested records do not exist), and GeneralError (for general retrieval failures). For execution errors during non-peak periods, retry functionality is recommended. Usage is metered based on API invocations with rule-based decision pricing applied. Users must configure appropriate follow-up actions for each outcome path to ensure comprehensive flow resilience and proper data handling across success and failure scenarios.

Use the Get Conversation Attributes action to retrieve multiple existing conversation attribute records. This action lets the flow reference previously captured custom data about those conversations and present the data in alignment with each record’s schema, creating further reuse opportunities.

Configure the Get Conversation Attributes action

Field	Description
Name	Type a distinctive name for the Get Conversation Attributes 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 records 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 records you want to retrieve. To narrow the selection, type the first few letters of the schema name.
Record IDs	Enter the unique IDs of all conversation attribute records that you want to retrieve.
Result	Assign a collection variable name to the retrieved conversation attribute records 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 Attributes 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 Attributes action. You can use the following errorType values: ActionInvocationLimitExceeded: If a flow has successfully run the Get Conversation Attributes 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 conversation attribute records, 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 Attributes 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 Attributes action.

You can use the following errorType values:

ActionInvocationLimitExceeded: If a flow has successfully run the Get Conversation Attributes 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 conversation attribute records, the action takes the failure path.

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

Configure found, partially found, and not found paths

Path	Description
Found	A Found path indicates that Architect has located all conversation attribute records. Drag the appropriate action below this path. Note: The Result field only populates when the flow follows the Found or Partially Found path.
Partially Found	A Partially Found path indicates that Architect located only some of the conversation attribute records that match the provided input, or that it located all records matching the input but some do not match the schema. The records that are not found appear as NOT_SET in the output collection. Drag the appropriate action below this path. Note: The Result field only populates when the flow follows the Found or Partially Found path.
Not Found	A Not Found path indicates that Architect did not find any conversation attribute record matching the record IDs or schema. 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 all conversation attribute records. Drag the appropriate action below this path.

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

Partially Found

A Partially Found path indicates that Architect located only some of the conversation attribute records that match the provided input, or that it located all records matching the input but some do not match the schema. The records that are not found appear as NOT_SET in the output collection. Drag the appropriate action below this path.

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

Not Found

A Not Found path indicates that Architect did not find any conversation attribute record matching the record IDs or schema. 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.