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

# Get v1voiceagentsclassifierscall outcomedefinitions



## OpenAPI

````yaml https://api.comm.com/docs/api.json get /v1/voice/agents/classifiers/call-outcome/definitions
openapi: 3.1.0
info:
  title: Commvoice API
  version: '1'
servers:
  - url: https://api.comm.com/api
    description: Live
security:
  - http: []
paths:
  /v1/voice/agents/classifiers/call-outcome/definitions:
    get:
      tags:
        - CallOutcomeClassifiers
      operationId: voice.classifiers.call-outcome.definitions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  definitions:
                    type: array
                    prefixItems:
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >-
                              Select this ONLY if:

                              - User explicitly agrees to the product or service

                              - User gives clear confirmation to proceed

                              - User accepts the offer

                              IMPORTANT: General engagement, neutral responses,
                              or inability to act immediately should NOT be
                              counted as interest without explicit agreement to
                              the product/service
                          format:
                            type: string
                            example: |-
                              outcome: interested
                              reason: (why you think the user is interested)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: |-
                              Select this ONLY if:
                              - User does not have enough money
                          format:
                            type: string
                            example: |-
                              outcome: not_qualified
                              reason: (why you think the user is not qualified)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >-
                              Select this ONLY if:

                              - User mentions a bad experience with the
                              product/service

                              - User expresses frustration or disappointment
                              with the product/service

                              - User shares a negative story or feedback about
                              the product/service

                              IMPORTANT: DO NOT select if the user is interested
                              or explicitly declines
                          format:
                            type: string
                            example: >-
                              outcome: burned_experience

                              reason: (why you think the user had a burned
                              experience)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >
                              Select this ONLY if HAVE AT LEAST 3 TURNS IN THE
                              CONVERSATION AND :

                              DO NOT SELECT IF CONVERSATION IS SHORT OR USER DID
                              NOT EXPRESS ANY EXPLICIT INTEREST OR DISINTEREST

                              - MUST HAVE AT LEAST 3 TURNS IN THE CONVERSATION

                              - User explicitly says they're not interested

                              - DO NOT select if the user said "I'm busy" or
                              "call me later" without further engagement

                              - DO NOT select if user only had 2 turns ("user:")
                              or less! f.e: "user: This is.." is not
                              not_interested outcome
                          format:
                            type: string
                            example: |-
                              outcome: not_interested
                              reason: (why you think the user is not interested)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >+
                              Select quick_hangup ONLY IF ANY OF FOLLOWING
                              CONDITIONS ARE MET:

                              - SELECT IF USER HANGS UP QUICKLY AFTER AGENT
                              STARTED SPEAKING

                              - IF the user hangs up without saying anything
                              meaningful and agent spoke - it's probably
                              quick_hangup


                              **ONLY USE THIS quick_hangup outcome if "user:"
                              AND "agent:" exist in transcript**


                              DO NOT SELECT quick_hangup if you do not see
                              "agent:" in transcript!


                              example for quick_hangup outcome:

                              1. user: Hello

                              agent: Hi, I'm calling you about...

                              <end of call, user hangs up quickly>


                          format:
                            type: string
                            example: |-
                              outcome: quick_hangup
                              reason: (why you think the user hung up quickly)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >
                              Select this ONLY if:

                              - The user speaks and theres no "agent:" at all in
                              transcript!!.

                              - Only for cases where there might be a technical
                              issue with agent. if the agent didnt have a good
                              sales pitch its not agent_issue!

                              - if the user repeatedly says "hello" or "are you
                              there?" theres an agent issue.

                              IF USER HANGS UP ON AGENT AFTER AGENT STARTED
                              SPEAKING INITITALLY DO NOT SELECT agent_issue.


                              EXAMPLE for agent_issue outcome:

                              1. user: Hello

                              <end of call, agent did not respond at all, user
                              hangs up quickly before agent speaks>
                          format:
                            type: string
                            example: |-
                              outcome: agent_issue
                              reason: (why you think the user hung up quickly)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >
                              Select this if ANY of these occur:

                              - The call reaches an automated voicemail or
                              messaging system.

                              - The call is answered by an automated system or
                              machine response (not a human).

                              - You hear a pre-recorded menu options or
                              instructions.

                              - If the user said hello or similar, it can't be a
                              voice mail.

                              - The speaker is primarily pronouncing numbers
                              (e.g., leaving a phone number).

                              - The user said "I'm not available right now" or
                              "Answer machine.." or similar without further
                              engagement.

                              IMPORTANT:

                              - DO NOT select if the user answering and taking
                              messages

                              - DO NOT select if the user said ONLY greetings or
                              "hello" without further engagement


                              Examples of voice_mail outcome:

                              - Es el servicio de contestador para 3...

                              - Encuentra disponible.
                          format:
                            type: string
                            example: |-
                              outcome: voice_mail
                              reason: (why you think the call reached voicemail)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >-
                              Select this ONLY if:

                              - User explicitly requests a callback

                              - User suggests a specific time for future contact

                              - User says something like "call me tomorrow/next
                              week/etc."

                              - User says he's busy right now.

                              - Call ended reason is not
                              "customer-did-not-answer"

                              IMPORTANT:
                                  - DO NOT select night hours (after 9 PM or before 9 AM) for callback
                                  - Must include specific date/time information when user provides it
                                  - You need to provide date and time in the user's timezone
                              Note: If only date is provided without time, use
                              format YYYY-MM-DD
                          format:
                            type: string
                            example: |-
                              outcome: call_me_later
                              call_me_back_at: YYYY-MM-DD HH:mm:ss
                              reason: (why you think the user wants a callback)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >-
                              Select this ONLY if:

                              - User explicitly asks to not be called again

                              - User requests removal from call list

                              - User states they don't want to receive any
                              future calls

                              IMPORTANT: Must be an explicit request, not just
                              current rejection
                          format:
                            type: string
                            example: >-
                              outcome: do_not_call

                              reason: (why you think the user doesn't want to be
                              called)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >-
                              Select this ONLY if:

                              - User shows some interest but is not fully
                              committed

                              - User asks for more information or details

                              - User expresses uncertainty or hesitation

                              - User asks for a follow-up or more time to think

                              IMPORTANT:

                              - DO NOT select if the user explicitly declines or
                              says they're not interested
                          format:
                            type: string
                            example: >-
                              outcome: maybe_interested

                              reason: (why you think the user is maybe
                              interested)
                        required:
                          - description
                          - format
                      - type: object
                        properties:
                          description:
                            type: string
                            example: >-
                              Select this ONLY if:

                              - User mentions any audio issues

                              - User complains about not hearing the agent

                              - User expresses frustration about the call
                              quality

                              IMPORTANT: DO NOT select if the user is not
                              interested or explicitly declines
                          format:
                            type: string
                            example: >-
                              outcome: audio_issue

                              reason: (why you think the user had an audio
                              issue)
                        required:
                          - description
                          - format
                      - type: 'null'
                      - type: 'null'
                      - type: 'null'
                      - type: 'null'
                    minItems: 15
                    maxItems: 15
                    additionalItems: false
                required:
                  - definitions
        '401':
          $ref: '#/components/responses/AuthenticationException'
components:
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
  securitySchemes:
    http:
      type: http
      scheme: bearer
      bearerFormat: JWT

````