Skip to main content
POST
/
api
/
v1
/
trigger-call
Trigger Call
curl --request POST \
  --url https://api.vodex.ai/api/v1/trigger-call \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'dburl: <dburl>' \
  --data '{
  "callList": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "phone": "<string>"
    }
  ],
  "projectId": "<string>",
  "consentForCalls": true
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "callsTriggered": 123,
    "callIds": [
      "<string>"
    ]
  }
}
🚨 Privacy & Consent Required: We value the privacy and preferences of customers. Phone calls can only be made to individuals who have explicitly provided their consent. Failing to comply with this policy may result in account suspension.
⚠️ Terms Confirmation: By using this API, you confirm that you have obtained the necessary consent from the provided phone numbers to be contacted. Please ensure you have reviewed and agree to our terms and conditions.

​
API Overview

The Trigger Call API supports multiple call configurations through a single endpoint. You can trigger:

🔹 Basic Calls

Simple calls with firstName, lastName, and phone number

🎯 Dynamic Fields

Calls with custom fields for personalized conversations

📊 Campaign Calls

Calls organized under campaign names for tracking

🧠 Insights Collection

Calls with AI-powered data collection and analysis
Before using this API, you must ensure:
  • ✅ Explicit Consent: All phone numbers have explicitly consented to receive calls
  • ✅ Documentation: You have documented proof of consent for each contact
  • ✅ Compliance: You comply with local privacy laws (GDPR, CCPA, etc.)
  • ✅ Opt-out Options: You provide clear opt-out mechanisms for contacts
The consentForCalls parameter must be set to true in your API request to confirm you have obtained proper consent from all contacts.

​
Call Configuration Types

​
1. Basic Calls

Use the basicTriggerCall schema for simple calls with minimal information:
  • firstName, lastName, phone
  • projectId and consentForCalls

​
2. Dynamic Fields Calls

Use the dynamicFieldsTriggerCall schema for personalized calls:
  • All basic fields plus custom fields (address, email, company, etc.)
  • Perfect for agent prompts that use {customField} variables
  • Additional Privacy: Ensure consent for personal data usage

​
3. Campaign Calls

Use the campaignTriggerCall schema for organized campaigns:
  • All basic fields plus campaignName
  • Better tracking and analytics
  • Marketing Compliance: Ensure consent for campaign communications

​
4. Insights Collection

Use the insightsTriggerCall schema for data collection:
  • All basic fields plus insights array with questions
  • AI-powered response analysis
  • Survey Consent: Ensure consent for data collection and AI processing

​
Privacy Considerations by Type

  • Basic Calls
  • Dynamic Fields
  • Campaign Calls
  • Insights Collection
  • Explicit consent for calling
  • Clear opt-out mechanisms
  • Compliance with local laws

​
Example Request Bodies

{
  "callList": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+1234567890"
    }
  ],
  "projectId": "your-project-id",
  "consentForCalls": true
}
The API automatically detects which type of call to trigger based on the fields present in your request body. No need to specify the call type explicitly.

Authorizations

​
Authorization
string
header
required

API Key authentication. Pass your API key in the Authorization header.

Headers

​
Authorization
string
required

API Key - authentication token for your account

​
dburl
string
required

Database URL - unique account identifier

Body

application/json

Call trigger payload - supports basic calls, dynamic fields, campaigns, or insights collection

  • Basic Call
  • Call with Dynamic Fields
  • Call with Campaign
  • Call with Insights
​
callList
object[]
required

Array of contact objects with basic information

​
projectId
string
required

Your Vodex project ID

​
consentForCalls
boolean
required

Must be true to confirm consent for calling

Response

Calls triggered successfully

  • Option 1
  • Option 2
  • Option 3
​
success
boolean

Whether the call trigger was successful

​
message
string

Response message

​
data
object