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>"
    ]
  }
}

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

callList
object[]
required

Array of contact objects with basic information

projectId
string
required

Your Vodex project ID

Must be true to confirm consent for calling

Response

Calls triggered successfully

success
boolean

Whether the call trigger was successful

message
string

Response message

data
object