> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telegent.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Call Filter Keywords

> View the keyword monitoring rules attached to a call filter.

**Prerequisites:**
- Bearer token — `POST /v1.0/oauth2/tokens`
- Subscriber ID and `CallFilterId` (`CFID-`)
- Call transcription must be enabled on the filter for keywords to take effect at runtime — set `EnableTranscription` to `true` via `POST /v1.0/subscribers/call-filter/update`

**What this does:** Returns the keyword filter configuration: `CustomKeywords` (your own words), `SystemKeywords` (Telegent-provided categories like Profanity, Threats), and `SeverityMap` (risk level per term: `HIGH`/`MEDIUM`/`LOW`). When transcription is on, calls are analyzed against these keywords and the configured `TranscriptionAction` is taken when a match is found.

**Next steps:**
- Add or change keywords — `POST /v1.0/subscribers/call-filter/update` (use the `KeywordFilter` field)
- See the rest of the filter — `GET /v1.0/subscribers/call-filter`



## OpenAPI

````yaml /api-reference/openapi.json get /v1.0/subscribers/call-filter/keywords
openapi: 3.0.3
info:
  title: mPaaS Core APIs
  version: 1.0.8
  description: >-
    The Telegent mPaaS (Mobile Platform as a Service) API gives you full
    programmatic control over mobile phone numbers, messaging, voice routing,
    subscribers, and account management. Use these APIs to provision MVNO and
    IoT numbers, send and receive SMS/MMS, configure intelligent call routing,
    manage subscriber accounts, and apply AI Guardian controls. All requests
    require a Bearer token obtained from the Authentication endpoint. For
    support, visit https://support.telegent.com/support/home
  contact:
    name: Support
    email: support@telegent.com
  termsOfService: https://telegent.com/terms
  license:
    name: Use under LICX
    url: https://telegent.com/license
servers:
  - url: https://api.telegent.com/v1.0
security:
  - BearerAuth: []
tags:
  - name: OAuth2
  - name: AI Guardian
  - name: Accounts
  - name: Distributors
  - name: Message
  - name: Numbers
  - name: Voicemail
  - name: Packages
  - name: Products
  - name: Schedules
  - name: Services
  - name: Sims
  - name: Subscribers
  - name: Subscriptions
  - name: Voice
  - name: Workgroups
paths:
  /v1.0/subscribers/call-filter/keywords:
    get:
      tags:
        - Subscribers
      summary: Get Call Filter Keywords
      description: >-
        View the keyword monitoring rules attached to a call filter.


        **Prerequisites:**

        - Bearer token — `POST /v1.0/oauth2/tokens`

        - Subscriber ID and `CallFilterId` (`CFID-`)

        - Call transcription must be enabled on the filter for keywords to take
        effect at runtime — set `EnableTranscription` to `true` via `POST
        /v1.0/subscribers/call-filter/update`


        **What this does:** Returns the keyword filter configuration:
        `CustomKeywords` (your own words), `SystemKeywords` (Telegent-provided
        categories like Profanity, Threats), and `SeverityMap` (risk level per
        term: `HIGH`/`MEDIUM`/`LOW`). When transcription is on, calls are
        analyzed against these keywords and the configured `TranscriptionAction`
        is taken when a match is found.


        **Next steps:**

        - Add or change keywords — `POST /v1.0/subscribers/call-filter/update`
        (use the `KeywordFilter` field)

        - See the rest of the filter — `GET /v1.0/subscribers/call-filter`
      parameters:
        - name: SubscriberId
          in: query
          required: true
          schema:
            type: string
          description: >-
            Telegent Subscriber ID. Format: `TSUID-` followed by a UUID. Create
            one via `POST /v1.0/subscribers/create` or look up existing IDs with
            `GET /v1.0/subscribers/get`.
        - name: CallFilterId
          in: query
          required: true
          schema:
            type: string
          description: >-
            Call Filter ID. Format: `CFID-` followed by a UUID. Returned by
            `POST /v1.0/subscribers/call-filter` (Create) or `GET
            /v1.0/subscribers/call-filter` (List).
        - name: AccountId
          in: query
          description: AccountId string
          schema:
            type: string
      responses:
        '200':
          description: Keywords Retrieved
          content:
            application/json:
              schema:
                type: object
              examples:
                example:
                  value:
                    CustomKeywords:
                      - inappropriate
                      - banned
                    SystemKeywords:
                      Profanity:
                        - word1
                        - word2
                      Violence:
                        - threat1
                    SeverityMap:
                      Word1: HIGH
                      Inappropriate: MEDIUM
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/BadRequest_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest_Result'
              examples:
                example:
                  value:
                    StatusCode: 400
                    Message: >-
                      Bad request: one or more required fields are missing or
                      contain an invalid value.
            text/json:
              schema:
                $ref: '#/components/schemas/BadRequest_Result'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Unauthorized_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized_Result'
              examples:
                example:
                  value:
                    StatusCode: 401
                    Message: >-
                      Unauthorized: Bearer token is missing, expired, or
                      invalid. Re-authenticate via POST /v1.0/oauth2/tokens.
            text/json:
              schema:
                $ref: '#/components/schemas/Unauthorized_Result'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Forbidden_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden_Result'
              examples:
                example:
                  value:
                    StatusCode: 403
                    Message: >-
                      Forbidden: your token does not have permission to access
                      this resource. Check the ApiEndpoint scope.
            text/json:
              schema:
                $ref: '#/components/schemas/Forbidden_Result'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/NotFound_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound_Result'
              examples:
                example:
                  value:
                    StatusCode: 404
                    Message: >-
                      Not found: the requested resource does not exist or
                      belongs to a different account.
            text/json:
              schema:
                $ref: '#/components/schemas/NotFound_Result'
        '405':
          description: Method Not Allowed
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/MethodNotAllowed_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowed_Result'
              examples:
                example:
                  value:
                    StatusCode: 405
                    Message: >-
                      Method not allowed: verify the HTTP method required for
                      this endpoint.
            text/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowed_Result'
        '408':
          description: Request Timeout
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RequestTimeout_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimeout_Result'
              examples:
                example:
                  value:
                    StatusCode: 408
                    Message: >-
                      Request timeout: the server did not receive a complete
                      request within the allowed time. Retry with exponential
                      backoff.
            text/json:
              schema:
                $ref: '#/components/schemas/RequestTimeout_Result'
        '429':
          description: Too Many Requests
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/TooManyRequests_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests_Result'
              examples:
                example:
                  value:
                    StatusCode: 429
                    Message: >-
                      Too many requests: rate limit exceeded. Slow your request
                      cadence and retry after a short delay.
            text/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests_Result'
        '500':
          description: Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/InternalServerError_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError_Result'
              examples:
                example:
                  value:
                    StatusCode: 500
                    Message: >-
                      Internal server error: an unexpected error occurred. If
                      the problem persists contact support@telegent.com.
            text/json:
              schema:
                $ref: '#/components/schemas/InternalServerError_Result'
        '503':
          description: Service Unavailable
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceUnavailable_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailable_Result'
              examples:
                example:
                  value:
                    StatusCode: 503
                    Message: >-
                      Service unavailable: the API is temporarily unavailable.
                      Retry after a short delay.
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailable_Result'
        '504':
          description: Gateway Timeout
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GatewayTimeout_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeout_Result'
              examples:
                example:
                  value:
                    StatusCode: 504
                    Message: >-
                      Gateway timeout: an upstream service did not respond in
                      time. Retry with exponential backoff.
            text/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeout_Result'
      x-codeSamples:
        - lang: cURL
          source: >-
            curl -X GET
            'https://api.telegent.com/v1.0/subscribers/call-filter/keywords?SubscriberId=TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441&CallFilterId=CFID-4bb4817b-7399-4949-97e9-ecad885a190f'
            \
              -H 'Authorization: Bearer YOUR_TOKEN'
components:
  schemas:
    BadRequest_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    Unauthorized_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    Forbidden_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    NotFound_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    MethodNotAllowed_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    RequestTimeout_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    TooManyRequests_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    InternalServerError_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    ServiceUnavailable_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    GatewayTimeout_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false

````