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

# Trigger Call

> Trigger automated calls with various configurations: basic calls, dynamic fields, campaign organization, or insights collection. The API supports multiple request formats based on your needs.



## OpenAPI

````yaml post /api/v1/trigger-call
openapi: 3.0.3
info:
  title: Vodex API
  description: >-
    Comprehensive API documentation for Vodex.ai - AI-powered telecalling and
    voice automation platform. Manage projects, campaigns, audiences, and
    analyze call data with our robust API suite.
  termsOfService: https://vodex.ai/terms-of-use
  contact:
    name: Vodex Developer Support
    email: developers@vodex.ai
    url: https://vodex.ai/support
  license:
    name: Proprietary
    url: https://vodex.ai/license
  version: 2.0.0
  x-logo:
    url: >-
      https://firebasestorage.googleapis.com/v0/b/lilchirp-io.appspot.com/o/logo.png?alt=media&token=3178b5f8-84ff-426d-ba89-8088fa2c4d92
    backgroundColor: '#FFFFFF'
    altText: Vodex
servers:
  - url: https://api.vodex.ai
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: >-
      Vodex uses API Key for authentication. If you are looking for the API
      Key(s) for your account, please fill the [Google
      Form](https://docs.google.com/forms/d/e/1FAIpQLSddntmCxrGt2TyKwPuXiDciLJC_dCMolSqU8qrikTNY00vr1A/viewform)
      with all the required details.
  - name: Projects
    description: >-
      Manage different projects in a single account. Create isolated bots for
      different use cases with comprehensive project management capabilities.
  - name: Audience
    description: >-
      Manage target audience information including names, mobile numbers, and
      custom fields for your calling campaigns.
  - name: Agent Setting
    description: >-
      Configure AI agents with custom prompts, greetings, context, and
      conversation flows for your telecalling campaigns.
  - name: Campaign
    description: >-
      Create, manage, and monitor telecalling campaigns with comprehensive
      campaign management tools.
  - name: Campaign Runs
    description: >-
      Track and analyze individual campaign execution runs with detailed
      performance metrics.
  - name: Call Trigger
    description: >-
      Trigger automated calls and manage call execution with custom parameters
      and real-time control.
  - name: Call Setting
    description: >-
      Configure call settings including caller ID, transfer numbers, voice
      settings, and call behavior parameters.
  - name: Advance Settings
    description: >-
      Advanced configuration options for API keys, rule IDs, account settings,
      and client configurations.
  - name: Appointment Settings
    description: >-
      Manage appointment booking settings, slot availability, and scheduling
      configurations for your campaigns.
  - name: Recording
    description: >-
      Upload and manage audio recordings for use in your telecalling campaigns
      and voice interactions.
  - name: Dashboard
    description: >-
      Access comprehensive analytics, metrics, and dashboard data for monitoring
      campaign performance.
  - name: Run Campaign Details
    description: >-
      Detailed analytics and reporting for individual campaign runs with
      filtering and pagination support.
  - name: Analyze
    description: >-
      AI-powered call analysis tools for generating summaries and extracting
      insights from call transcripts.
  - name: Twilio
    description: >-
      Twilio integration for caller ID verification and OTP management for
      enhanced call security.
externalDocs:
  description: Find out more about Vodex
  url: https://vodex.ai
paths:
  /api/v1/trigger-call:
    post:
      tags:
        - Call Trigger
      summary: Trigger Call
      description: >-
        Trigger automated calls with various configurations: basic calls,
        dynamic fields, campaign organization, or insights collection. The API
        supports multiple request formats based on your needs.
      operationId: triggerCallController
      parameters:
        - name: Authorization
          in: header
          description: API Key - authentication token for your account
          required: true
          schema:
            type: string
        - name: dburl
          in: header
          description: Database URL - unique account identifier
          required: true
          schema:
            type: string
      requestBody:
        description: >-
          Call trigger payload - supports basic calls, dynamic fields,
          campaigns, or insights collection
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/basicTriggerCall'
                  title: Basic Call
                - $ref: '#/components/schemas/dynamicFieldsTriggerCall'
                  title: Call with Dynamic Fields
                - $ref: '#/components/schemas/campaignTriggerCall'
                  title: Call with Campaign
                - $ref: '#/components/schemas/insightsTriggerCall'
                  title: Call with Insights
        required: true
      responses:
        '200':
          description: Calls triggered successfully
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/triggerCallResponse'
                  - $ref: '#/components/schemas/campaignTriggerCallResponse'
                  - $ref: '#/components/schemas/insightsTriggerCallResponse'
        '400':
          description: Bad Request - Invalid call data or missing consent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    basicTriggerCall:
      required:
        - callList
        - projectId
        - consentForCalls
      type: object
      properties:
        callList:
          type: array
          description: Array of contact objects with basic information
          items:
            $ref: '#/components/schemas/basicContact'
        projectId:
          type: string
          description: Your Vodex project ID
        consentForCalls:
          type: boolean
          description: Must be true to confirm consent for calling
    dynamicFieldsTriggerCall:
      required:
        - callList
        - projectId
        - consentForCalls
      type: object
      properties:
        callList:
          type: array
          description: Array of contact objects with dynamic custom fields
          items:
            $ref: '#/components/schemas/dynamicContact'
        projectId:
          type: string
          description: Your Vodex project ID
        consentForCalls:
          type: boolean
          description: Must be true to confirm consent for calling
    campaignTriggerCall:
      required:
        - callList
        - projectId
        - campaignName
        - consentForCalls
      type: object
      properties:
        callList:
          type: array
          description: Array of contact objects for the campaign
          items:
            $ref: '#/components/schemas/basicContact'
        projectId:
          type: string
          description: Your Vodex project ID
        campaignName:
          type: string
          description: Name to organize calls under for tracking and analytics
        consentForCalls:
          type: boolean
          description: Must be true to confirm consent for calling
    insightsTriggerCall:
      required:
        - callList
        - projectId
        - insights
        - consentForCalls
      type: object
      properties:
        callList:
          type: array
          description: Array of contact objects for insights collection
          items:
            $ref: '#/components/schemas/basicContact'
        projectId:
          type: string
          description: Your Vodex project ID
        insights:
          type: array
          description: Array of insight questions to collect during calls
          items:
            $ref: '#/components/schemas/insightQuestion'
        consentForCalls:
          type: boolean
          description: Must be true to confirm consent for calling
    triggerCallResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the call trigger was successful
        message:
          type: string
          description: Response message
        data:
          type: object
          properties:
            callsTriggered:
              type: integer
              description: Number of calls triggered
            callIds:
              type: array
              description: Array of call IDs generated
              items:
                type: string
    campaignTriggerCallResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the campaign call trigger was successful
        message:
          type: string
          description: Response message
        data:
          type: object
          properties:
            campaignName:
              type: string
              description: Name of the campaign
            callsTriggered:
              type: integer
              description: Number of calls triggered
            callIds:
              type: array
              description: Array of call IDs generated
              items:
                type: string
            campaignId:
              type: string
              description: Generated campaign ID
    insightsTriggerCallResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the insights call trigger was successful
        message:
          type: string
          description: Response message
        data:
          type: object
          properties:
            callsTriggered:
              type: integer
              description: Number of calls triggered
            callIds:
              type: array
              description: Array of call IDs generated
              items:
                type: string
            insightsConfigured:
              type: array
              description: List of insight questions configured
              items:
                type: string
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
    basicContact:
      required:
        - firstName
        - lastName
        - phone
      type: object
      properties:
        firstName:
          type: string
          description: Contact's first name
        lastName:
          type: string
          description: Contact's last name
        phone:
          type: string
          description: Contact's phone number with country code
    dynamicContact:
      required:
        - firstName
        - lastName
        - phone
      type: object
      properties:
        firstName:
          type: string
          description: Contact's first name
        lastName:
          type: string
          description: Contact's last name
        phone:
          type: string
          description: Contact's phone number with country code
        address:
          type: string
          description: Contact's address (dynamic field example)
        email:
          type: string
          description: Contact's email address (dynamic field example)
        company:
          type: string
          description: Contact's company name (dynamic field example)
      additionalProperties:
        type: string
        description: Any additional custom fields used in your agent prompt
    insightQuestion:
      required:
        - question
        - type
        - key
      type: object
      properties:
        question:
          type: string
          description: The question to ask or information to collect
        type:
          type: string
          enum:
            - text
            - number
            - boolean
          description: Type of response expected
        key:
          type: string
          description: A variable name for the question
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: API Key authentication. Pass your API key in the Authorization header.
      name: Authorization
      in: header

````