Create a campaign
curl --request POST \
--url https://apiv2.vodex.ai/v1/contacts/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"audienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "<string>",
"concurrency": 123,
"retry": {
"on": [
"<string>"
],
"schedule": [
{
"gapMinutes": 5040.5,
"leaveVoicemail": true
}
],
"attempts": 5,
"backoffMinutes": 5040.5,
"surveyCutOff": false
},
"window": {
"localStart": "09:00",
"localEnd": "20:00",
"timezoneField": "tz",
"timezone": "America/New_York",
"days": [
1,
2,
3,
4,
5
]
},
"fromStrategy": "<string>",
"fromNumbers": [
"<string>"
],
"fromWeights": {},
"variables": {
"first_name": "field:firstName",
"balance": "attr:balance"
},
"blockSize": 123,
"startAt": "2023-11-07T05:31:56Z",
"repeat": {
"timezone": "<string>"
}
}
'import requests
url = "https://apiv2.vodex.ai/v1/contacts/campaigns"
payload = {
"name": "<string>",
"audienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "<string>",
"concurrency": 123,
"retry": {
"on": ["<string>"],
"schedule": [
{
"gapMinutes": 5040.5,
"leaveVoicemail": True
}
],
"attempts": 5,
"backoffMinutes": 5040.5,
"surveyCutOff": False
},
"window": {
"localStart": "09:00",
"localEnd": "20:00",
"timezoneField": "tz",
"timezone": "America/New_York",
"days": [1, 2, 3, 4, 5]
},
"fromStrategy": "<string>",
"fromNumbers": ["<string>"],
"fromWeights": {},
"variables": {
"first_name": "field:firstName",
"balance": "attr:balance"
},
"blockSize": 123,
"startAt": "2023-11-07T05:31:56Z",
"repeat": { "timezone": "<string>" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
audienceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assistantId: '<string>',
concurrency: 123,
retry: {
on: ['<string>'],
schedule: [{gapMinutes: 5040.5, leaveVoicemail: true}],
attempts: 5,
backoffMinutes: 5040.5,
surveyCutOff: false
},
window: {
localStart: '09:00',
localEnd: '20:00',
timezoneField: 'tz',
timezone: 'America/New_York',
days: [1, 2, 3, 4, 5]
},
fromStrategy: '<string>',
fromNumbers: ['<string>'],
fromWeights: {},
variables: {first_name: 'field:firstName', balance: 'attr:balance'},
blockSize: 123,
startAt: '2023-11-07T05:31:56Z',
repeat: {timezone: '<string>'}
})
};
fetch('https://apiv2.vodex.ai/v1/contacts/campaigns', 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://apiv2.vodex.ai/v1/contacts/campaigns",
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([
'name' => '<string>',
'audienceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assistantId' => '<string>',
'concurrency' => 123,
'retry' => [
'on' => [
'<string>'
],
'schedule' => [
[
'gapMinutes' => 5040.5,
'leaveVoicemail' => true
]
],
'attempts' => 5,
'backoffMinutes' => 5040.5,
'surveyCutOff' => false
],
'window' => [
'localStart' => '09:00',
'localEnd' => '20:00',
'timezoneField' => 'tz',
'timezone' => 'America/New_York',
'days' => [
1,
2,
3,
4,
5
]
],
'fromStrategy' => '<string>',
'fromNumbers' => [
'<string>'
],
'fromWeights' => [
],
'variables' => [
'first_name' => 'field:firstName',
'balance' => 'attr:balance'
],
'blockSize' => 123,
'startAt' => '2023-11-07T05:31:56Z',
'repeat' => [
'timezone' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://apiv2.vodex.ai/v1/contacts/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"audienceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"<string>\",\n \"concurrency\": 123,\n \"retry\": {\n \"on\": [\n \"<string>\"\n ],\n \"schedule\": [\n {\n \"gapMinutes\": 5040.5,\n \"leaveVoicemail\": true\n }\n ],\n \"attempts\": 5,\n \"backoffMinutes\": 5040.5,\n \"surveyCutOff\": false\n },\n \"window\": {\n \"localStart\": \"09:00\",\n \"localEnd\": \"20:00\",\n \"timezoneField\": \"tz\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n },\n \"fromStrategy\": \"<string>\",\n \"fromNumbers\": [\n \"<string>\"\n ],\n \"fromWeights\": {},\n \"variables\": {\n \"first_name\": \"field:firstName\",\n \"balance\": \"attr:balance\"\n },\n \"blockSize\": 123,\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"repeat\": {\n \"timezone\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://apiv2.vodex.ai/v1/contacts/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"audienceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"<string>\",\n \"concurrency\": 123,\n \"retry\": {\n \"on\": [\n \"<string>\"\n ],\n \"schedule\": [\n {\n \"gapMinutes\": 5040.5,\n \"leaveVoicemail\": true\n }\n ],\n \"attempts\": 5,\n \"backoffMinutes\": 5040.5,\n \"surveyCutOff\": false\n },\n \"window\": {\n \"localStart\": \"09:00\",\n \"localEnd\": \"20:00\",\n \"timezoneField\": \"tz\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n },\n \"fromStrategy\": \"<string>\",\n \"fromNumbers\": [\n \"<string>\"\n ],\n \"fromWeights\": {},\n \"variables\": {\n \"first_name\": \"field:firstName\",\n \"balance\": \"attr:balance\"\n },\n \"blockSize\": 123,\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"repeat\": {\n \"timezone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/contacts/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"audienceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"<string>\",\n \"concurrency\": 123,\n \"retry\": {\n \"on\": [\n \"<string>\"\n ],\n \"schedule\": [\n {\n \"gapMinutes\": 5040.5,\n \"leaveVoicemail\": true\n }\n ],\n \"attempts\": 5,\n \"backoffMinutes\": 5040.5,\n \"surveyCutOff\": false\n },\n \"window\": {\n \"localStart\": \"09:00\",\n \"localEnd\": \"20:00\",\n \"timezoneField\": \"tz\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n },\n \"fromStrategy\": \"<string>\",\n \"fromNumbers\": [\n \"<string>\"\n ],\n \"fromWeights\": {},\n \"variables\": {\n \"first_name\": \"field:firstName\",\n \"balance\": \"attr:balance\"\n },\n \"blockSize\": 123,\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"repeat\": {\n \"timezone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"audienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "<string>",
"status": "<string>",
"batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startAt": "2023-11-07T05:31:56Z",
"repeat": {
"every": "daily",
"timezone": "<string>"
},
"nextRunAt": "2023-11-07T05:31:56Z",
"lastRepeat": {
"at": "2023-11-07T05:31:56Z",
"outcome": "launched",
"reason": "<string>",
"runNo": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"outcomes": {}
}{
"error": "not found"
}Campaigns
Create a campaign
A campaign is not a second dialer. Execution is batches — same
runner, same number rotation, same calling-window logic. What a campaign
adds is who: an audience instead of a pasted list, and a row keyed to
a person instead of a bare number (0017 §4).
Creating one dials nobody. POST /contacts/campaigns/{id}/launch does.
Repeat. With repeat set, every launch also schedules the next
one: the campaign launches itself again at the same local time the next
day, week or month (nextRunAt), and each run resolves the audience
afresh, so it calls whoever matches on that day. A run that comes due
while the previous one is still dialing or paused is skipped, not
queued, and so is a run reached more than two hours after its time;
lastRepeat says which run was skipped and why. A startAt
set between runs makes the next run happen then. The repeat is
armed by a launch — or at once, when it is set on a campaign that is
already running — and turned off by repeat: null, by
POST /contacts/campaigns/{id}/stop, or by cancelling its run
(POST /batches/{id}/cancel). A campaign run in blocks cannot
repeat.
POST
/
contacts
/
campaigns
Create a campaign
curl --request POST \
--url https://apiv2.vodex.ai/v1/contacts/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"audienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "<string>",
"concurrency": 123,
"retry": {
"on": [
"<string>"
],
"schedule": [
{
"gapMinutes": 5040.5,
"leaveVoicemail": true
}
],
"attempts": 5,
"backoffMinutes": 5040.5,
"surveyCutOff": false
},
"window": {
"localStart": "09:00",
"localEnd": "20:00",
"timezoneField": "tz",
"timezone": "America/New_York",
"days": [
1,
2,
3,
4,
5
]
},
"fromStrategy": "<string>",
"fromNumbers": [
"<string>"
],
"fromWeights": {},
"variables": {
"first_name": "field:firstName",
"balance": "attr:balance"
},
"blockSize": 123,
"startAt": "2023-11-07T05:31:56Z",
"repeat": {
"timezone": "<string>"
}
}
'import requests
url = "https://apiv2.vodex.ai/v1/contacts/campaigns"
payload = {
"name": "<string>",
"audienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "<string>",
"concurrency": 123,
"retry": {
"on": ["<string>"],
"schedule": [
{
"gapMinutes": 5040.5,
"leaveVoicemail": True
}
],
"attempts": 5,
"backoffMinutes": 5040.5,
"surveyCutOff": False
},
"window": {
"localStart": "09:00",
"localEnd": "20:00",
"timezoneField": "tz",
"timezone": "America/New_York",
"days": [1, 2, 3, 4, 5]
},
"fromStrategy": "<string>",
"fromNumbers": ["<string>"],
"fromWeights": {},
"variables": {
"first_name": "field:firstName",
"balance": "attr:balance"
},
"blockSize": 123,
"startAt": "2023-11-07T05:31:56Z",
"repeat": { "timezone": "<string>" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
audienceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assistantId: '<string>',
concurrency: 123,
retry: {
on: ['<string>'],
schedule: [{gapMinutes: 5040.5, leaveVoicemail: true}],
attempts: 5,
backoffMinutes: 5040.5,
surveyCutOff: false
},
window: {
localStart: '09:00',
localEnd: '20:00',
timezoneField: 'tz',
timezone: 'America/New_York',
days: [1, 2, 3, 4, 5]
},
fromStrategy: '<string>',
fromNumbers: ['<string>'],
fromWeights: {},
variables: {first_name: 'field:firstName', balance: 'attr:balance'},
blockSize: 123,
startAt: '2023-11-07T05:31:56Z',
repeat: {timezone: '<string>'}
})
};
fetch('https://apiv2.vodex.ai/v1/contacts/campaigns', 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://apiv2.vodex.ai/v1/contacts/campaigns",
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([
'name' => '<string>',
'audienceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assistantId' => '<string>',
'concurrency' => 123,
'retry' => [
'on' => [
'<string>'
],
'schedule' => [
[
'gapMinutes' => 5040.5,
'leaveVoicemail' => true
]
],
'attempts' => 5,
'backoffMinutes' => 5040.5,
'surveyCutOff' => false
],
'window' => [
'localStart' => '09:00',
'localEnd' => '20:00',
'timezoneField' => 'tz',
'timezone' => 'America/New_York',
'days' => [
1,
2,
3,
4,
5
]
],
'fromStrategy' => '<string>',
'fromNumbers' => [
'<string>'
],
'fromWeights' => [
],
'variables' => [
'first_name' => 'field:firstName',
'balance' => 'attr:balance'
],
'blockSize' => 123,
'startAt' => '2023-11-07T05:31:56Z',
'repeat' => [
'timezone' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://apiv2.vodex.ai/v1/contacts/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"audienceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"<string>\",\n \"concurrency\": 123,\n \"retry\": {\n \"on\": [\n \"<string>\"\n ],\n \"schedule\": [\n {\n \"gapMinutes\": 5040.5,\n \"leaveVoicemail\": true\n }\n ],\n \"attempts\": 5,\n \"backoffMinutes\": 5040.5,\n \"surveyCutOff\": false\n },\n \"window\": {\n \"localStart\": \"09:00\",\n \"localEnd\": \"20:00\",\n \"timezoneField\": \"tz\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n },\n \"fromStrategy\": \"<string>\",\n \"fromNumbers\": [\n \"<string>\"\n ],\n \"fromWeights\": {},\n \"variables\": {\n \"first_name\": \"field:firstName\",\n \"balance\": \"attr:balance\"\n },\n \"blockSize\": 123,\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"repeat\": {\n \"timezone\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://apiv2.vodex.ai/v1/contacts/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"audienceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"<string>\",\n \"concurrency\": 123,\n \"retry\": {\n \"on\": [\n \"<string>\"\n ],\n \"schedule\": [\n {\n \"gapMinutes\": 5040.5,\n \"leaveVoicemail\": true\n }\n ],\n \"attempts\": 5,\n \"backoffMinutes\": 5040.5,\n \"surveyCutOff\": false\n },\n \"window\": {\n \"localStart\": \"09:00\",\n \"localEnd\": \"20:00\",\n \"timezoneField\": \"tz\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n },\n \"fromStrategy\": \"<string>\",\n \"fromNumbers\": [\n \"<string>\"\n ],\n \"fromWeights\": {},\n \"variables\": {\n \"first_name\": \"field:firstName\",\n \"balance\": \"attr:balance\"\n },\n \"blockSize\": 123,\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"repeat\": {\n \"timezone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/contacts/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"audienceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"<string>\",\n \"concurrency\": 123,\n \"retry\": {\n \"on\": [\n \"<string>\"\n ],\n \"schedule\": [\n {\n \"gapMinutes\": 5040.5,\n \"leaveVoicemail\": true\n }\n ],\n \"attempts\": 5,\n \"backoffMinutes\": 5040.5,\n \"surveyCutOff\": false\n },\n \"window\": {\n \"localStart\": \"09:00\",\n \"localEnd\": \"20:00\",\n \"timezoneField\": \"tz\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n },\n \"fromStrategy\": \"<string>\",\n \"fromNumbers\": [\n \"<string>\"\n ],\n \"fromWeights\": {},\n \"variables\": {\n \"first_name\": \"field:firstName\",\n \"balance\": \"attr:balance\"\n },\n \"blockSize\": 123,\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"repeat\": {\n \"timezone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"audienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "<string>",
"status": "<string>",
"batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startAt": "2023-11-07T05:31:56Z",
"repeat": {
"every": "daily",
"timezone": "<string>"
},
"nextRunAt": "2023-11-07T05:31:56Z",
"lastRepeat": {
"at": "2023-11-07T05:31:56Z",
"outcome": "launched",
"reason": "<string>",
"runNo": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"outcomes": {}
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Body
application/json
Show child attributes
Show child attributes
When this batch may dial — outside it, rows wait rather than fail. A row's own timezone (the timezoneField variable) wins over timezone; a row with neither fails with no_timezone.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Assistant variable -> where its value comes from: field:<column>, attr:<key>, stat:attemptsTotal / stat:attempts7d, or any other string as literal text. A variable named after a contact field (first_name) needs no entry.
Show child attributes
Show child attributes
Example:
{
"first_name": "field:firstName",
"balance": "attr:balance"
}
Dial the audience in blocks of this size, one at a time.
Launch the campaign again on this schedule. Each run starts at the same local time as the run it repeats, in timezone, across daylight-saving changes; a monthly run on the 31st falls on the last day of a shorter month. null turns it off.
Show child attributes
Show child attributes
Response
Created, not launched.
Derived from the underlying batch on every read, never stored — so the two can never disagree.
Launch the campaign again on this schedule. Each run starts at the same local time as the run it repeats, in timezone, across daylight-saving changes; a monthly run on the 31st falls on the last day of a shorter month. null turns it off.
Show child attributes
Show child attributes
When the campaign launches itself next. Null when it does not repeat, has not been launched since the repeat was set, or was stopped.
What happened the last time a repeat came due. A skipped run says why — the previous run still dialing, an audience that matches nobody, a deleted agent.
Show child attributes
Show child attributes
What the conversations reached (design 0018), keyed by the customer's own name for each outcome. Scoped to batchId's current run — a ranged campaign's earlier blocks are not included.
Show child attributes
Show child attributes