---
title: "GET /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers"
method: GET
path: "/v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers"
tags: ["projects"]
---

# GET /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers

`GET /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers`

## Request

- Base URL: `https://contactcenterinsights.googleapis.com`
- URL: `https://contactcenterinsights.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers`
- 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`

Lists phrase matchers.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required

## Query parameters

- `filter` string
- `pageSize` integer
- `pageToken` string

## Response `200`

Successful response

- GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: The response of listing phrase matchers.
  - `nextPageToken` string: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  - `phraseMatchers` GoogleCloudContactcenterinsightsV1PhraseMatcher[]: The phrase matchers that match the request.
    - `activationUpdateTime` string, google-datetime: Output only. The most recent time at which the activation status was updated.
    - `active` boolean: Applies the phrase matcher only when it is active.
    - `displayName` string: The human-readable name of the phrase matcher.
    - `name` string: The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    - `phraseMatchRuleGroups` GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup[]: A list of phase match rule groups that are included in this matcher.
      - `phraseMatchRules` GoogleCloudContactcenterinsightsV1PhraseMatchRule[]: A list of phrase match rules that are included in this group.
        - `config` GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: Configuration information of a phrase match rule.
          - `exactMatchConfig` GoogleCloudContactcenterinsightsV1ExactMatchConfig: Exact match configuration.
            - `caseSensitive` boolean: Whether to consider case sensitivity when performing an exact match.
          - `regexMatchConfig` GoogleCloudContactcenterinsightsV1RegexMatchConfig: Regex match configuration.
        - `negated` boolean: Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
        - `query` string: Required. The phrase to be matched.
      - `type` 'PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED' | 'ALL_OF' | 'ANY_OF': Required. The type of this phrase match rule group.
    - `revisionCreateTime` string, google-datetime: Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
    - `revisionId` string: Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
    - `roleMatch` 'ROLE_UNSPECIFIED' | 'HUMAN_AGENT' | 'AUTOMATED_AGENT' | 'END_USER' | 'ANY_AGENT': The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
    - `type` 'PHRASE_MATCHER_TYPE_UNSPECIFIED' | 'ALL_OF' | 'ANY_OF': Required. The type of this phrase matcher.
    - `updateTime` string, google-datetime: Output only. The most recent time at which the phrase matcher was updated.
    - `versionTag` string: The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.

---

[API](https://skmtc.dev/google/apis/contactcenterinsights.md) - [All operations](https://skmtc.dev/google/apis/contactcenterinsights/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/contactcenterinsights/revisions/895c3ce55ea0?raw)