Method: projects.locations.phraseMatchers.list

Lists phrase matchers.

HTTP request

GET https://{endpoint}/v1alpha1/{parent=projects/*/locations/*}/phraseMatchers

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource of the phrase matcher.

Query parameters

Parameters
pageSize

integer

The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty nextPageToken in the response indicates that more data is available.
pageToken

string

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

string

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

Request body

The request body must be empty.

Response body

The response of listing phrase matchers.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "phraseMatchers": [
    {
      object (PhraseMatcher)
    }
  ],
  "nextPageToken": string
}
Fields
phraseMatchers[]

object (PhraseMatcher)

The phrase matchers that match the request.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • contactcenterinsights.phraseMatchers.list

For more information, see the IAM documentation.