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

# Get a call

> Read one call your organization owns.



## OpenAPI

````yaml /openapi/backend.json get /api/calls/{call_id}
openapi: 3.0.3
info:
  title: Drive Health operational API
  version: 1.0.0
  description: >-
    Server-to-server API for organizations integrating with Drive Health. It
    starts chat and voice conversations and reads the calls, chats, transcripts,
    and recordings those conversations produce. Authenticate every request with
    an organization API key.
servers:
  - url: https://backend.drivehealth.ai
    description: Production. Use the API origin supplied for your environment.
security:
  - organizationBearer: []
  - organizationApiKey: []
tags:
  - name: Chat
    description: >-
      Start a chat with a caregiver, exchange messages, and end the session.
      These routes also answer on the compatibility mount `/v1/chat/...`.
  - name: Voice
    description: Start phone calls from an owned number and register browser voice calls.
  - name: Results
    description: >-
      Read the calls, chat sessions, transcripts, and recordings your
      organization owns.
paths:
  /api/calls/{call_id}:
    get:
      tags:
        - Results
      summary: Get a call
      description: Read one call your organization owns.
      operationId: getCall
      parameters:
        - name: call_id
          in: path
          required: true
          description: ID of a call your organization owns.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The call record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallResponse'
              example:
                err: false
                msg: Success
                results:
                  call_id: 3c2b1a09-8f7e-4d6c-9b8a-7d6c5b4a3f2e
                  protocol: web
                  status: completed
                  call_duration_seconds: 211
                  resolved: false
                  call_recording_url: >-
                    https://backend.drivehealth.ai/api/calls/recording/3c2b1a09-8f7e-4d6c-9b8a-7d6c5b4a3f2e
        '400':
          description: The call was not found in your organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              example:
                err: true
                msg: Call record not found.
        '403':
          $ref: '#/components/responses/Refused'
components:
  schemas:
    CallResponse:
      type: object
      required:
        - err
        - msg
        - results
      properties:
        err:
          type: boolean
          example: false
        msg:
          type: string
          example: Success
        results:
          $ref: '#/components/schemas/CallRecord'
    ErrorEnvelope:
      type: object
      required:
        - err
        - msg
      properties:
        err:
          type: boolean
          example: true
        msg:
          type: string
          description: What went wrong.
    CallRecord:
      type: object
      description: >-
        A call your organization owns. Records include further fields that this
        reference does not describe yet.
      additionalProperties: true
      properties:
        call_id:
          type: string
          format: uuid
        protocol:
          type: string
          description: 'How the call was carried: `twilio`, `telnyx`, `web`, or `sip`.'
        from_number:
          type: string
          nullable: true
          description: Calling number, when the call has one.
        to_number:
          type: string
          nullable: true
          description: Called number, when the call has one.
        start_time:
          type: string
          format: date-time
          nullable: true
        end_time:
          type: string
          format: date-time
          nullable: true
        call_duration_seconds:
          type: integer
          minimum: 0
          nullable: true
        status:
          type: string
          description: >-
            Call status, for example `completed`, `failed`, `busy`, or
            `no-answer`.
        transcript:
          type: string
          nullable: true
          description: The conversation as text.
        transcript_object:
          description: The conversation as structured turns, or null.
        sentiment:
          type: string
          nullable: true
          description: >-
            Sentiment from call analysis, for example `positive`, `neutral`, or
            `negative`.
        who_hung_up:
          type: string
          nullable: true
          description: Which side ended the call, for example `caller` or `callee`.
        resolved:
          type: boolean
          description: Whether the call is marked resolved.
        notes:
          type: string
          nullable: true
          maxLength: 150
        call_analysis:
          type: object
          nullable: true
          additionalProperties: true
          description: Analysis of the call. Its fields are not described yet.
        call_recording_url:
          type: string
          format: uri
          nullable: true
          description: >-
            Authorized recording URL on the current API host. Fetch it with your
            organization key.
    Refusal:
      type: object
      required:
        - detail
      properties:
        detail:
          type: string
          description: Why the request was refused.
  responses:
    Refused:
      description: >-
        Refused before the endpoint ran, with `detail` instead of the standard
        envelope: the key is missing, invalid, or revoked; more than one
        credential was presented; or a selector names a different organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
          examples:
            invalidKey:
              summary: Invalid or revoked key
              value:
                detail: Unauthorized
            noCredential:
              summary: No credential
              value:
                detail: Authentication credentials were not provided.
            conflictingCredentials:
              summary: More than one credential
              value:
                detail: >-
                  More than one credential was presented. Send an organization
                  key or a session token, not both.
            foreignSelector:
              summary: Selector names another organization
              value:
                detail: >-
                  This key belongs to a different organization than the request
                  selected.
  securitySchemes:
    organizationBearer:
      type: http
      scheme: bearer
      description: >-
        An organization API key starting with `dh_`, sent as `Authorization:
        Bearer dh_your_api_key`.
    organizationApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Alternative to the Authorization header. Send one credential per
        request.

````

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