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

# Start voice call

> Start a voice call to one or more numbers.



## OpenAPI

````yaml /en/voice-api/api-reference/openapi-voice.json post /v1/voice/calls
openapi: 3.0.3
info:
  title: Notifique API Voice
  description: >-
    Make voice calls and control active calls. Authenticate with `Authorization:
    Bearer sk_live_...` or `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Production
security:
  - ntfVoiceBearerAuth: []
  - ntfVoiceApiKeyHeader: []
tags:
  - name: 'Voice: Chamadas'
    description: Originar, listar, consultar e controlar chamadas de voz.
paths:
  /v1/voice/calls:
    post:
      tags:
        - 'Voice: Chamadas'
      summary: Start voice call
      description: Start a voice call to one or more numbers.
      operationId: ntfVoice_postV1VoiceCalls
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NtfVoice_CreateBody'
            example:
              from: '+5511987654321'
              to:
                - '+5511999887766'
              type: speak
              payload:
                text: Hello! Test call.
                voice: female-natural
              clientState: campanha-42
      responses:
        '202':
          description: Chamada enfileirada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfVoice_SingleEnvelope'
        '400':
          description: Parâmetros inválidos (from/to).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfVoice_ErrorEnvelope'
        '401':
          $ref: '#/components/responses/NtfVoice_Unauthorized'
        '402':
          description: Saldo insuficiente ou workspace bloqueado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfVoice_ErrorEnvelope'
              example:
                success: false
                error: Payment Required
                code: WORKSPACE_BLOCKED
                message: Payment Required
        '403':
          $ref: '#/components/responses/NtfVoice_Forbidden'
components:
  schemas:
    NtfVoice_CreateBody:
      type: object
      required:
        - from
        - to
        - type
        - payload
      properties:
        from:
          type: string
          description: Workspace phone number id or E.164.
        to:
          oneOf:
            - type: array
              items:
                type: string
              minItems: 1
              maxItems: 100
            - type: string
          description: >-
            E.164 destination (+...). Prefer an array (canonical); string
            accepted for compatibility.
        type:
          type: string
          enum:
            - speak
            - play
            - gather
            - template
          description: >-
            Initial action: `speak` (TTS in `payload.text`), `play`
            (`payload.audioUrl`), `gather` (`payload.gather`), `template`
            (`payload.templateId`).
        payload:
          type: object
          description: >-
            Content per `type`. **speak:** `text`, optional `voice`/`language`.
            **play:** `audioUrl`. **gather:** `gather` object. **template:**
            `templateId` + optional `variables`.
        record:
          type: boolean
        machineDetection:
          type: string
          example: detect
        clientState:
          type: string
    NtfVoice_SingleEnvelope:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/NtfVoice_VoiceCall'
    NtfVoice_ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        message:
          type: string
        code:
          type: string
    NtfVoice_VoiceCall:
      type: object
      properties:
        id:
          type: string
        workspaceId:
          type: string
        phoneNumberId:
          type: string
          nullable: true
        direction:
          type: string
          enum:
            - OUTBOUND
            - INBOUND
        fromE164:
          type: string
        toE164:
          type: string
        status:
          type: string
          enum:
            - QUEUED
            - INITIATED
            - RINGING
            - ANSWERED
            - COMPLETED
            - FAILED
        callSessionId:
          type: string
          nullable: true
        callLegId:
          type: string
          nullable: true
        answeredAt:
          type: string
          format: date-time
          nullable: true
        endedAt:
          type: string
          format: date-time
          nullable: true
        durationSecs:
          type: integer
          nullable: true
        hangupCause:
          type: string
          nullable: true
        recordingAvailable:
          type: boolean
        recordingId:
          type: string
          nullable: true
        dtmfDigits:
          type: string
          nullable: true
        gatherResult:
          type: string
          nullable: true
        machineDetectionResult:
          type: string
          nullable: true
        speakText:
          type: string
          nullable: true
        playAudioUrl:
          type: string
          nullable: true
        chargedAs:
          type: string
          nullable: true
        chargeAmount:
          type: number
          nullable: true
        clientState:
          type: string
          nullable: true
        metadata:
          type: object
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  responses:
    NtfVoice_Unauthorized:
      description: Missing or invalid API Key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfVoice_ErrorEnvelope'
    NtfVoice_Forbidden:
      description: Escopo insuficiente.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfVoice_ErrorEnvelope'
          example:
            success: false
            error: Forbidden
            message: 'Missing scope: voice:call'
            code: FORBIDDEN
  securitySchemes:
    ntfVoiceBearerAuth:
      type: http
      scheme: bearer
      description: 'API Key no formato Bearer (ex.: sk_live_...).'
    ntfVoiceApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````