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
}
'import requests
url = "https://api.vodex.ai/api/v1/trigger-call"
payload = {
"callList": [
{
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
}
],
"projectId": "<string>",
"consentForCalls": True
}
headers = {
"Authorization": "<api-key>",
"dburl": "<dburl>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<api-key>',
dburl: '<dburl>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
callList: [{firstName: '<string>', lastName: '<string>', phone: '<string>'}],
projectId: '<string>',
consentForCalls: true
})
};
fetch('https://api.vodex.ai/api/v1/trigger-call', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vodex.ai/api/v1/trigger-call",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'callList' => [
[
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>'
]
],
'projectId' => '<string>',
'consentForCalls' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"dburl: <dburl>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vodex.ai/api/v1/trigger-call"
payload := strings.NewReader("{\n \"callList\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"consentForCalls\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("dburl", "<dburl>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vodex.ai/api/v1/trigger-call")
.header("Authorization", "<api-key>")
.header("dburl", "<dburl>")
.header("Content-Type", "application/json")
.body("{\n \"callList\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"consentForCalls\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vodex.ai/api/v1/trigger-call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["dburl"] = '<dburl>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"callList\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"consentForCalls\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"callsTriggered": 123,
"callIds": [
"<string>"
]
}
}{
"code": 123
}{
"code": 123
}{
"code": 123
}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.
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
}
'import requests
url = "https://api.vodex.ai/api/v1/trigger-call"
payload = {
"callList": [
{
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
}
],
"projectId": "<string>",
"consentForCalls": True
}
headers = {
"Authorization": "<api-key>",
"dburl": "<dburl>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<api-key>',
dburl: '<dburl>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
callList: [{firstName: '<string>', lastName: '<string>', phone: '<string>'}],
projectId: '<string>',
consentForCalls: true
})
};
fetch('https://api.vodex.ai/api/v1/trigger-call', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vodex.ai/api/v1/trigger-call",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'callList' => [
[
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>'
]
],
'projectId' => '<string>',
'consentForCalls' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"dburl: <dburl>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vodex.ai/api/v1/trigger-call"
payload := strings.NewReader("{\n \"callList\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"consentForCalls\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("dburl", "<dburl>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vodex.ai/api/v1/trigger-call")
.header("Authorization", "<api-key>")
.header("dburl", "<dburl>")
.header("Content-Type", "application/json")
.body("{\n \"callList\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"consentForCalls\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vodex.ai/api/v1/trigger-call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["dburl"] = '<dburl>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"callList\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"consentForCalls\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"callsTriggered": 123,
"callIds": [
"<string>"
]
}
}{
"code": 123
}{
"code": 123
}{
"code": 123
}Authorizations
API Key authentication. Pass your API key in the Authorization header.
Headers
API Key - authentication token for your account
Database URL - unique account identifier
Body
application/json
Call trigger payload - supports basic calls, dynamic fields, campaigns, or insights collection
โI