Genesys Cloud icon

Genesys Cloud

Consume Genesys Cloud API

Actions20

Conversation → Get Many

AI-generated

Summary

Retrieve multiple conversation records from Genesys Cloud within a specified date range, optionally applying filters and sorting, and control pagination to return all or a limited number of results.

Inputs

  • Authentication (required) — OAuth2 authorization used to authenticate with Genesys Cloud API.
  • Return All (required) — Whether to return all matching conversations or limit the number of results.
  • Limit — Maximum number of conversations to return if not returning all (1-100).
  • Start Date (required) — Start date and time (ISO 8601) for filtering conversations.
  • End Date (required) — End date and time (ISO 8601) for filtering conversations.
  • Options — Additional options such as sort order, sort field, and segment-level filters.
  • Options.Order — Sort conversations ascending or descending.
  • Options.Order By — Field to order conversations by: conversation start/end or segment start/end.
  • Options.Segment Filters — Filters to narrow conversations by segment dimensions like direction, media type, queue ID, user ID, or wrap-up code.

Output shape

a list of conversation records matching the query criteria

Retrieves conversation details within the specified interval via a POST request to the analytics query endpoint; supports pagination automatically. Date inputs must be valid ISO 8601 strings with start date earlier than end date. Segment filters are applied as AND predicates on conversation segments. Returning all results may yield more than the specified limit if 'Return All' is true.

Examples

Example 1: Get up to 50 conversations starting between 2024-01-01 and 2024-01-31, sorted ascending by conversation start

Set 'Return All' to false, 'Limit' to 50, specify 'Start Date' as 2024-01-01T00:00:00Z, 'End Date' as 2024-01-31T23:59:59Z, and use default 'Order' (asc) and 'Order By' (conversationStart).

Example 2: Get all inbound voice conversations handled by a specific queue between two dates

Set 'Return All' to true, specify 'Start Date' and 'End Date', under 'Options.Segment Filters' add filters for 'Direction' matches 'inbound', 'Media Type' matches 'voice', and 'Queue ID' matches the target queue ID.

Links

Discussion