Skip to main content
POST
/
v2
/
admin
/
call-campaigns
Create Campaign
curl --request POST \
  --url https://api.voxo.co/v2/admin/call-campaigns/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 1,
  "name": "<string>",
  "tech": "VOICE",
  "dateStart": "<string>",
  "timeStart": "<string>",
  "dateEnd": "<string>",
  "timeEnd": "<string>",
  "callerId": "<string>",
  "recording": "yes",
  "numbers": [
    {
      "number": "<string>",
      "description": "<string>",
      "field1": "<string>",
      "field2": "<string>",
      "field3": "<string>",
      "field4": "<string>",
      "field5": "<string>",
      "field6": "<string>",
      "field7": "<string>",
      "field8": "<string>",
      "field9": "<string>",
      "disposition": "<string>"
    }
  ],
  "destinations": [
    {
      "id": 1,
      "type": "<string>"
    }
  ],
  "timezone": "<string>",
  "callFrequency": 10,
  "matchDestinations": [
    {
      "id": 1,
      "type": "<string>"
    }
  ],
  "notMatchDestinations": [
    {
      "id": 1,
      "type": "<string>"
    }
  ],
  "enableVMDetect": "<string>",
  "callHoursStart": "<string>",
  "callHoursEnd": "<string>"
}
'
{
  "id": 123,
  "tenantId": 123,
  "name": "<string>",
  "type": "<string>",
  "dateStart": "<string>",
  "dateEnd": "<string>",
  "callerId": "<string>",
  "callDelay": 123,
  "state": "<string>",
  "lastrun": "<string>",
  "dialtimeout": 123,
  "tech": "<string>",
  "message": "<string>",
  "timeStart": "<string>",
  "timeEnd": "<string>",
  "timezone": "<string>",
  "callFrequency": 123,
  "callHoursStart": "<string>",
  "callHoursEnd": "<string>",
  "recording": "<string>",
  "numbers": [
    {
      "number": "<string>",
      "description": "<string>",
      "disposition": "<string>"
    }
  ],
  "destinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123
    }
  ],
  "enableVMDetect": 123,
  "matchDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123
    }
  ],
  "notMatchDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tenantId
number
required

Tenant ID this campaign belongs to

Required range: x > 0
name
string
required

Campaign name

Minimum string length: 3
tech
enum<string>
required

Campaign technology type

Available options:
VOICE
dateStart
string
required

Start date (YYYY-MM-DD)

Pattern: ^([1-9]\d{3})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])$
timeStart
string
required

Start time (HH:MM)

Pattern: ^([01]\d|2[0-3]):([0-5]\d)$
dateEnd
string
required

End date (YYYY-MM-DD)

Pattern: ^([1-9]\d{3})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])$
timeEnd
string
required

End time (HH:MM)

Pattern: ^([01]\d|2[0-3]):([0-5]\d)$
callerId
string
required

Caller ID phone number

Pattern: ^[1-9]\d{9}$
recording
required

Enable call recording (yes/no)

Available options:
yes
numbers
object[]
required

Phone numbers to call

destinations
object[]
required

Routing destinations on connect

timezone
string
required

IANA timezone identifier

callFrequency
number
required

Call frequency in seconds (minimum 10)

Required range: x > 9
matchDestinations
object[]
required

VM detect match destinations

notMatchDestinations
object[]
required

VM detect no-match destinations

enableVMDetect
string
required

Enable voicemail detection (1 = yes, 0 = no)

callHoursStart
string
required

Calling hours start time (HH:MM)

Pattern: ^([01]\d|2[0-3]):([0-5]\d)$
callHoursEnd
string
required

Calling hours end time (HH:MM)

Pattern: ^([01]\d|2[0-3]):([0-5]\d)$
state
enum<string>

Initial campaign state

Available options:
READY,
PAUSED
message
string

Campaign message

Response

Created campaign

id
number
required

Campaign ID

tenantId
number
required

Tenant ID

name
string
required

Campaign name

type
string
required

Campaign type

dateStart
string | null
required

Start date

dateEnd
string | null
required

End date

callerId
string | null
required

Caller ID phone number

callDelay
number | null
required

Delay between calls in ms

state
string | null
required

Campaign state

lastrun
string | null
required

Last run timestamp

dialtimeout
number | null
required

Dial timeout in seconds

tech
string | null
required

Technology type

message
string | null
required

Campaign message

timeStart
string | null
required

Start time

timeEnd
string | null
required

End time

timezone
string | null
required

IANA timezone

callFrequency
number | null
required

Call frequency in seconds

callHoursStart
string | null
required

Calling hours start

callHoursEnd
string | null
required

Calling hours end

recording
string | null
required

Recording enabled (yes/no)

numbers
object[]
required

Campaign phone numbers

destinations
object[]
required

Routing destinations

enableVMDetect
number
required

VM detection enabled (1/0)

matchDestinations
object[]
required

VM detect match destinations

notMatchDestinations
object[]
required

VM detect no-match destinations