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

# Start a call

> Places an outbound call. Returns the call with its `uuid` for tracking and control.



## OpenAPI

````yaml https://wavix.github.io/wavix-openapi/wavix-api.yaml post /v1/calls
openapi: 3.1.0
info:
  title: Wavix APIs
  description: >-
    Wavix provides robust APIs that let you integrate voice and text messaging
    features directly into your app. Send text, place calls, and access detailed
    reports  programmatically.
  termsOfService: https://wavix.com/terms-and-conditions
  license:
    name: MIT
    identifier: MIT
  contact:
    name: Wavix
    url: https://wavix.com
    email: support@wavix.com
  version: '1.0'
servers:
  - url: https://api.wavix.com
    description: https://api.wavix.com
    variables: {}
security:
  - bearerAuth: []
tags:
  - name: SIP trunks
    description: SIP trunks
  - name: Buy
    description: Numbers
  - name: Cart
    description: Numbers
  - name: My numbers
    description: Numbers
  - name: Billing
    description: Billing, transactions, and invoices
  - name: Profile
    description: Account profile and customer information
  - name: CDRs
    description: Call detail records and call history
  - name: Speech Analytics
    description: Call transcription and speech analytics
  - name: SMS and MMS
    description: Messaging
  - name: Number Validator
    description: Phone number validation
  - name: Link shortener
    description: Short link and click metrics
  - name: 2FA
    description: Two-factor authentication
  - name: 10DLC
    description: 10DLC Campaigns and Brands
  - name: API Keys
    description: API key management
  - name: Call webhooks
    description: Webhook configuration for call events
  - name: Call control
    description: Programmable Voice
  - name: Call streaming
    description: Real-time call audio streaming over WebSocket
  - name: Call recording
    description: Call recording
  - name: Sub-accounts
    description: Sub-account management
  - name: Voice campaigns
    description: Outbound voice campaigns
  - name: Wavix Embeddable
    description: WebRTC embeddable widget
paths:
  /v1/calls:
    post:
      tags:
        - Call control
      summary: Start a call
      description: >-
        Places an outbound call. Returns the call with its `uuid` for tracking
        and control.
      operationId: call_control_create
      parameters: []
      requestBody:
        description: Attributes for the new outbound call.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallRequest'
        required: true
      responses:
        '200':
          description: Returns the created call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallCreateResponse'
              examples:
                success:
                  summary: Successful response
                  value:
                    uuid: 5dccb6b0-f35c-488c-867b-86fb012c4415
                    direction: inbound
                    event_type: call_setup
                    event_time: '2025-09-22T12:56:38.547Z'
                    event_payload: null
                    from: '+18045961058'
                    to: '17653889567'
                    call_started: '2025-09-22T12:56:38.547Z'
                    call_answered: '2023-06-15T10:30:00Z'
                    call_completed: '2023-06-15T10:30:00Z'
                    machine_detected: false
                    tag: ''
        '400':
          description: Returns a validation error when a request parameter is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallControlValidationErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
      deprecated: false
      security:
        - bearerAuth:
            - calls:write
components:
  schemas:
    CallRequest:
      type: object
      additionalProperties: false
      required:
        - from
        - to
        - callback_url
      properties:
        from:
          type: string
          description: >-
            Caller ID. Must be an active or verified phone number on the
            account.
          example: '+1234567890'
        to:
          type: string
          description: Destination number in E.164 format
          example: '+1987654321'
        callback_url:
          type: string
          description: The callback URL where Wavix sends the call status updates
          example: https://examples.com/callback
        recording:
          type: boolean
          description: Specifies whether to record the call
          default: false
        voicemail_detection:
          type: boolean
          description: Specifies whether the AMD is turned on for the call
          default: false
        tag:
          type: string
          description: Call metadata
          example: marketing-campaign
        timeout:
          type: integer
          description: >-
            The ring timeout, in seconds, before the call is considered
            unanswered.
          example: 60
    CallCreateResponse:
      type: object
      additionalProperties: false
      properties:
        uuid:
          type: string
          format: uuid
          deprecated: true
          description: Call ID. Deprecated — use `id` instead.
          example: 5dccb6b0-f35c-488c-867b-86fb012c4415
        id:
          type: string
          format: uuid
          description: Call ID. Alias of `uuid`.
          example: 5dccb6b0-f35c-488c-867b-86fb012c4415
        direction:
          $ref: '#/components/schemas/CallDirection'
        event_type:
          type: string
          description: >-
            Most recent lifecycle event for the call. One of:


            - `call_setup` — the call is being initiated.

            - `ringing` — the destination is ringing.

            - `early_media` — early media (such as ringback) is playing before
            answer.

            - `answered` — the destination answered the call.

            - `completed` — the call ended normally.

            - `busy` — the destination was busy.

            - `cancelled` — the call was cancelled before answer.

            - `rejected` — the destination rejected the call.

            - `on_call_event` — an in-call event occurred (see `event_payload`).
          enum:
            - call_setup
            - ringing
            - early_media
            - answered
            - completed
            - busy
            - cancelled
            - rejected
            - on_call_event
          example: call_setup
        event_time:
          type: string
          format: date-time
          description: Date and time of the latest event
          example: '2025-09-22T12:56:38.547Z'
        event_payload:
          description: Event-specific data
          oneOf:
            - $ref: '#/components/schemas/OnCallEventPayload'
            - type: 'null'
          example:
            type: audio
            payload:
              status: completed
              playback_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: Caller ID
          example: '+18045961058'
        to:
          type: string
          description: Destination number
          example: '17653889567'
        call_started:
          type: string
          format: date-time
          description: Date and time when the call started
          example: '2025-09-22T12:56:38.547Z'
        call_answered:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time when the call was answered
        call_completed:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time when the call ended
        machine_detected:
          type: boolean
          description: Indicates whether the call was answered by an answering machine
          example: false
        tag:
          type: string
          description: Call metadata
          example: ''
    CallControlValidationErrorResponse:
      title: CallControlValidationErrorResponse
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          description: >-
            Indicates whether the request was successful. Always `false` for
            this error.
          example: false
        message:
          type: string
          description: Human-readable summary of the validation failure.
          example: Validation error
        errors:
          type: object
          description: |
            Field-level validation messages, keyed by the offending request
            field name (snake_case). Absent when the request body could not be
            parsed at all (for example, malformed JSON).
          additionalProperties:
            type: string
          example:
            to: required
    CallDirection:
      type: string
      enum:
        - inbound
        - outbound
      description: >-
        Direction of the call. One of `inbound` (call received by the account)
        or `outbound` (call placed by the account).
    OnCallEventPayload:
      type: object
      description: Payload for the `on_call_event` event type.
      required:
        - type
      properties:
        type:
          type: string
          description: >-
            Type of in-call sub-event. One of `audio` (audio playback progress)
            or `collect` (DTMF digit collection progress).
          enum:
            - audio
            - collect
          example: audio
        payload:
          type:
            - object
            - 'null'
          description: >-
            Sub-event-specific data. Structure depends on the `type` field:

            - `audio`: `{ "status": "started" | "completed", "playback_id":
            "<uuid>" }`

            - `collect`: `{ "digits": "<digits>", "status": "started" |
            "completed" | "failed" }`
          example:
            status: completed
            playback_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
    UnauthorizedErrorResponse:
      title: UnauthorizedErrorResponse
      type: object
      properties:
        success:
          type: boolean
          description: >-
            Indicates whether the request was successful. Always `false` for
            this error.
          example: false
        error:
          type: boolean
          description: >-
            Indicates that the response represents an error. Always `true` for
            this error.
          example: true
        message:
          type: string
          description: >-
            Human-readable description stating that authentication is missing or
            invalid.
          example: Unauthorized
  responses:
    UnauthorizedErrorResponse:
      description: Unauthorized
      headers: {}
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Wavix API key. Pass as `Authorization: Bearer <api_key>`. Keys support
        per-resource scopes (none / read / write). See [Restricted keys and
        scopes](https://docs.wavix.com/api-reference/authentication#restricted-keys-and-scopes).

````