GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/conversations

Lists conversations.

Request

  • Base URL
    https://contactcenterinsights.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required

Query parameters

filterstring

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

orderBystring

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.

pageSizeinteger

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.

pageTokenstring

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.

view'CONVERSATION_VIEW_UNSPECIFIED' | 'FULL' | 'BASIC' | 'FULL_WITH_STRUCTURED_TRANSCRIPT'

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

Response

Successful response

nextPageTokenstring

A token which can be sent as page_token to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.

Changes

No recorded changes to this operation across all 6 revisions of this API.