Skip to main content
GET
Get Campaign

Authorizations

Authorization
string
header
required

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

Path Parameters

campaignId
string
required

Campaign ID

Pattern: ^[1-9]\d*$

Response

Campaign details

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<date-time> | 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