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

# Retrieve a structured call result

> Read a canonical display classification and voicemail reports for a Public API call. Display results do not replace the legacy Automation outcome. classification_status reports availability: processing can reflect an ongoing call or pending post-call content, without certifying a classifier job; poll only processing. unavailable means no current classification and can change after later analysis. A human correction suppresses the AI classification. revision is a content hash, not an increasing number. Quoted evidence is omitted without transcripts:read.



## OpenAPI

````yaml /openapi/openapi.yaml get /calls/{call_id}/result
openapi: 3.1.0
info:
  title: Brightalk Public API
  version: '2026-07-16'
  description: >-
    Server-to-server REST API for AI calls, batch dialing, and dashboard-managed
    Automation definitions.
  license:
    name: Brightalk API Terms
    identifier: LicenseRef-Brightalk-API
servers:
  - url: https://api.brightalk.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Agents
    description: Eligible dashboard-managed AI voice agents.
  - name: Automations
    description: Dashboard-managed Automation summaries.
  - name: Contacts
    description: Organization contacts and external identities.
  - name: Calls
    description: Immediate asynchronous AI calls and their scalar results.
  - name: Batches
    description: Draft, schedule, and control aggregate batch dialing.
  - name: Automation runs
    description: Create and control one-contact Automation runs.
  - name: Recordings
    description: Metadata and short-lived signed download URLs for call recordings.
  - name: LINE messages
    description: Send text to linked contacts and retrieve send receipts.
paths:
  /calls/{call_id}/result:
    get:
      tags:
        - Calls
      summary: Retrieve a structured call result
      description: >-
        Read a canonical display classification and voicemail reports for a
        Public API call. Display results do not replace the legacy Automation
        outcome. classification_status reports availability: processing can
        reflect an ongoing call or pending post-call content, without certifying
        a classifier job; poll only processing. unavailable means no current
        classification and can change after later analysis. A human correction
        suppresses the AI classification. revision is a content hash, not an
        increasing number. Quoted evidence is omitted without transcripts:read.
      operationId: getCallResult
      parameters:
        - $ref: '#/components/parameters/BrightalkVersion'
        - $ref: '#/components/parameters/XRequestId'
        - $ref: '#/components/parameters/CallIdPath'
      responses:
        '200':
          description: Current call history or result returned.
          headers:
            Brightalk-Version:
              $ref: '#/components/headers/Brightalk-Version'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl --request GET
            'https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/result'
            \
              --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
              --header "Brightalk-Version: 2026-07-16"
        - lang: javascript
          label: JavaScript
          source: >-
            const response = await
            fetch("https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/result",
            {
              method: "GET",
              headers: {
                Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
                "Brightalk-Version": "2026-07-16",
              },
            });

            console.log(response.status, await response.json());
        - lang: python
          label: Python
          source: |-
            import os
            import requests

            response = requests.request(
                "GET",
                "https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/result",
                headers={
                "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
                "Brightalk-Version": "2026-07-16",
                },
            )
            print(response.status_code, response.json())
components:
  parameters:
    BrightalkVersion:
      name: Brightalk-Version
      in: header
      required: false
      description: >-
        Selects the date-based API version. Omission uses the organization’s
        pinned default.
      schema:
        type: string
        const: '2026-07-16'
        default: '2026-07-16'
    XRequestId:
      name: X-Request-Id
      in: header
      required: false
      description: >-
        A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}.
        Invalid values are replaced.
      schema:
        type: string
        pattern: ^[A-Za-z0-9._:-]{1,64}$
        maxLength: 64
    CallIdPath:
      name: call_id
      in: path
      required: true
      description: The opaque Call identifier.
      schema:
        type: string
        format: uuid
        minLength: 1
        maxLength: 255
        description: An opaque resource identifier.
        example: 11111111-1111-4111-8111-111111111111
  headers:
    Brightalk-Version:
      description: The date-based version applied to the request.
      required: true
      schema:
        type: string
        const: '2026-07-16'
    X-Request-Id:
      description: The accepted caller correlation value or a server-generated replacement.
      required: true
      schema:
        type: string
        pattern: ^[A-Za-z0-9._:-]{1,64}$
    RateLimit-Limit:
      description: The effective request allowance for the selected bucket.
      schema:
        type: integer
        minimum: 1
    RateLimit-Remaining:
      description: The nonnegative number of requests remaining in the selected bucket.
      schema:
        type: integer
        minimum: 0
    RateLimit-Reset:
      description: >-
        A nonnegative integer number of delta-seconds from response generation
        until the effective bucket resets; never an epoch timestamp.
      schema:
        type: integer
        minimum: 0
    Allow:
      description: A comma-separated list of methods allowed on the known path.
      schema:
        type: string
        example: GET, POST
    Retry-After:
      description: >-
        A nonnegative integer number of delta-seconds to wait before retrying;
        never an epoch timestamp.
      schema:
        type: integer
        minimum: 0
  schemas:
    CallResult:
      type: object
      properties:
        object:
          type: string
          const: call_result
        schema_version:
          type: string
          const: '2026-11-18'
        call_id:
          anyOf:
            - type: string
              format: uuid
              pattern: >-
                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            - type: string
              pattern: >-
                ^(?:ai|human)_[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
        revision:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: >-
            SHA-256 fingerprint of projected response content. Compare for
            equality; it is not monotonic.
        classification_status:
          type: string
          enum:
            - processing
            - ready
            - unavailable
          description: >-
            Availability of the retained classification: ready means a current
            result exists; processing means the call is ongoing or its post-call
            summary pipeline is pending, without certifying a running classifier
            job. unavailable means no current result, including after a failed
            summary, and can change after later classification.
        classification_unavailable_reason:
          anyOf:
            - type: string
              enum:
                - not_recorded
                - manually_corrected
            - type: 'null'
        poll_after_seconds:
          anyOf:
            - type: number
              const: 5
            - type: 'null'
        outcome:
          anyOf:
            - type: string
            - type: 'null'
        outcome_reason:
          anyOf:
            - type: string
            - type: 'null'
        conversation_result:
          anyOf:
            - $ref: '#/components/schemas/ConversationResult'
            - type: 'null'
        voicemail:
          $ref: '#/components/schemas/VoicemailResult'
      required:
        - object
        - schema_version
        - call_id
        - revision
        - classification_status
        - classification_unavailable_reason
        - poll_after_seconds
        - outcome
        - outcome_reason
        - conversation_result
        - voicemail
      additionalProperties: false
    ConversationResult:
      type: object
      properties:
        version:
          type: string
          const: universal-v1
        code:
          type: string
          enum:
            - agreed_human_contact
            - booking_requested
            - booking_confirmed
            - attendance_confirmed
            - reschedule_requested
            - cancellation_requested
            - information_requested
            - considering
            - no_current_need
            - declined
            - do_not_contact
            - temporarily_unavailable
            - callback_requested
            - customer_will_contact
            - unclear_intent
            - no_effective_response
            - service_resolved
            - service_pending
            - gatekeeper_reached
            - wrong_contact
            - voicemail_reached
            - unable_to_determine
        reason:
          type: string
          minLength: 1
          maxLength: 240
        evidence:
          maxItems: 3
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 300
          description: >-
            Quoted evidence is present only with transcripts:read. An empty
            array means the classifier supplied no quotes.
      required:
        - version
        - code
        - reason
      additionalProperties: false
    VoicemailResult:
      type: object
      properties:
        detected:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            null means no retained evidence, not false. false is returned only
            for an explicit human correction away from voicemail.
        source:
          type: string
          enum:
            - operator
            - transcript_analysis
            - call_signal
            - unknown
        message_status:
          type: string
          enum:
            - reported_complete
            - failed
            - unknown
          description: >-
            reported_complete is a runtime report that its message flow
            completed, not proof that the complete audio was played or
            delivered. Missing historical reports remain unknown.
      required:
        - detected
        - source
        - message_status
      additionalProperties: false
    ErrorEnvelope:
      type: object
      additionalProperties: false
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
    Error:
      type: object
      additionalProperties: false
      properties:
        code:
          type: string
          enum:
            - authentication_required
            - invalid_api_key
            - api_key_expired
            - organization_not_enabled
            - insufficient_scope
            - unsupported_version
            - validation_error
            - invalid_json
            - resource_not_found
            - resource_state_conflict
            - method_not_allowed
            - request_too_large
            - unsupported_destination
            - contact_identity_conflict
            - idempotency_key_required
            - idempotency_conflict
            - idempotency_in_progress
            - duplicate_active_run
            - rate_limit_exceeded
            - recipient_blocked_by_policy
            - internal_error
          example: validation_error
        message:
          type: string
          example: The request could not be validated.
        request_id:
          type: string
          pattern: ^[A-Za-z0-9._:-]{1,64}$
          example: req_demo_001
        details:
          $ref: '#/components/schemas/ErrorDetails'
      required:
        - code
        - message
        - request_id
    ErrorDetails:
      type: object
      additionalProperties: false
      properties:
        reason:
          type: string
          description: >-
            LINE resource conflict reason. No send was claimed; correct the
            binding or channel before retrying.
          enum:
            - line_multiple_accounts
            - line_not_following
            - line_not_linked
            - line_recipient_invalid
            - line_channel_missing
        fields:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/ErrorField'
        truncated:
          type: boolean
          const: true
        supported_versions:
          type: array
          items:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        existing_run_id:
          type: string
          minLength: 1
          maxLength: 255
          description: An opaque resource identifier.
          example: run_demo_001
    ErrorField:
      type: object
      additionalProperties: false
      properties:
        path:
          type: string
          example: recipient.phone_number
        code:
          type: string
          example: invalid_e164
      required:
        - path
        - code
  responses:
    BadRequest:
      description: >-
        The version, request, query, or state-independent destination validation
        failed.
      headers:
        Brightalk-Version:
          $ref: '#/components/headers/Brightalk-Version'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            validationError:
              value:
                error:
                  code: validation_error
                  message: The request could not be validated.
                  request_id: req_demo_001
                  details:
                    fields:
                      - path: recipient.phone_number
                        code: invalid_e164
            unsupportedVersion:
              value:
                error:
                  code: unsupported_version
                  message: The requested API version is not supported.
                  request_id: req_demo_001
                  details:
                    supported_versions:
                      - '2026-07-16'
            unsupportedDestination:
              value:
                error:
                  code: unsupported_destination
                  message: The destination is not supported.
                  request_id: req_demo_001
    Unauthorized:
      description: Authentication failed.
      headers:
        Brightalk-Version:
          $ref: '#/components/headers/Brightalk-Version'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            missingBearer:
              value:
                error:
                  code: authentication_required
                  message: Authentication is required.
                  request_id: req_demo_001
            malformedBearer:
              value:
                error:
                  code: authentication_required
                  message: Authentication is required.
                  request_id: req_demo_001
            unknownOrRevokedCredential:
              value:
                error:
                  code: invalid_api_key
                  message: The API key is invalid.
                  request_id: req_demo_001
            expiredCredential:
              value:
                error:
                  code: api_key_expired
                  message: The API key has expired.
                  request_id: req_demo_001
    Forbidden:
      description: The request is not authorized for this API operation.
      headers:
        Brightalk-Version:
          $ref: '#/components/headers/Brightalk-Version'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            organizationNotEnabled:
              value:
                error:
                  code: organization_not_enabled
                  message: The organization is not enabled for the Public API.
                  request_id: req_demo_001
            insufficientScope:
              value:
                error:
                  code: insufficient_scope
                  message: The API key does not have the required scope.
                  request_id: req_demo_001
    NotFound:
      description: The resource is absent or not visible to this organization.
      headers:
        Brightalk-Version:
          $ref: '#/components/headers/Brightalk-Version'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            resourceNotFound:
              value:
                error:
                  code: resource_not_found
                  message: The requested resource was not found.
                  request_id: req_demo_001
    MethodNotAllowed:
      description: The path is known but the method is not allowed.
      headers:
        Brightalk-Version:
          $ref: '#/components/headers/Brightalk-Version'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        Allow:
          $ref: '#/components/headers/Allow'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            methodNotAllowed:
              value:
                error:
                  code: method_not_allowed
                  message: The method is not allowed for this resource.
                  request_id: req_demo_001
    TooManyRequests:
      description: The selected request bucket is exhausted.
      headers:
        Brightalk-Version:
          $ref: '#/components/headers/Brightalk-Version'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            rateLimitExceeded:
              value:
                error:
                  code: rate_limit_exceeded
                  message: The rate limit has been exceeded.
                  request_id: req_demo_001
    InternalError:
      description: The request could not be completed safely.
      headers:
        Brightalk-Version:
          $ref: '#/components/headers/Brightalk-Version'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            internalError:
              value:
                error:
                  code: internal_error
                  message: An unexpected error occurred.
                  request_id: req_demo_001
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Brightalk API key
      description: Use a server-side Brightalk API key in the Authorization header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.