Contact Center AI Insights v1 API - Class ListConversationsRequest (2.18.0)

public sealed class ListConversationsRequest : IMessage<ListConversationsRequest>, IEquatable<ListConversationsRequest>, IDeepCloneable<ListConversationsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Contact Center AI Insights v1 API class ListConversationsRequest.

Request to list conversations.

Inheritance

object > ListConversationsRequest

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

ListConversationsRequest()

public ListConversationsRequest()

ListConversationsRequest(ListConversationsRequest)

public ListConversationsRequest(ListConversationsRequest other)
Parameter
Name Description
other ListConversationsRequest

Properties

Filter

public string Filter { get; set; }

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:

  • create_time
  • customer_satisfaction_rating
  • duration
  • latest_analysis
  • start_time
  • turn_count

The default sort order is ascending. To specify order, append asc or desc (create_time desc). For more details, see Google AIPs Ordering.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The parent resource of the conversation.

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

View

public ConversationView View { get; set; }

The level of details of the conversation. Default is BASIC.

Property Value
Type Description
ConversationView