Skip to content
vocapable.Docs

Outbound campaigns (CC4)

GET
/v1/workspace/contact-center/dialer/campaigns
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/contact-center/dialer/campaigns \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcDialerCampaigns
object
data
required
Data
Array<object>
CcDialerCampaign
object
id
required
Id
string
revision
required
Revision
integer
name
required
Name
string
description
required
Any of:
string
status
required
Status
string
Allowed values: draft active paused completed archived
mode
required
Mode
string
Allowed values: preview progressive power predictive
purpose
required
Purpose
string
Allowed values: marketing informational transactional
seller_name
required
Seller Name
string
abandon_message
required
Abandon Message
string
abandon_message_version
required
Abandon Message Version
integer
abandon_message_problems
required
Abandon Message Problems
Array<string>
opt_out_digit
required
Opt Out Digit
string
callback_number_id
required
Any of:
string
default_number_id
required
Any of:
string
local_presence
required
Local Presence
boolean
ring_seconds
required
Ring Seconds
integer
preview_seconds
required
Any of:
integer
power_ratio
required
Any of:
number
amd_enabled
required
Amd Enabled
boolean
voicemail_drop_id
required
Any of:
string
script
required
Script
string
dispositions
required
Dispositions
Array<object>
CcDialerDisposition

One disposition and its retry rule (no retry = final).

object
key
required
Key
string
>= 1 characters <= 40 characters /^[a-z][a-z0-9_]{0,39}$/
label
required
Label
string
>= 1 characters <= 60 characters
outcome_class
required
Outcome Class
string
Allowed values: contact right_party_contact sale callback dnc wrong_number no_answer voicemail
retry_after_minutes
Any of:
integer
<= 43200
max_attempts
Any of:
integer
>= 1 <= 20
best_windows
required
Best Windows
Array<object>
CcDialerWindow

A best-time window in the lead’s local time.

object
start
required
Start
string
/^([01]\d|2[0-3]):[0-5]\d$/
end
required
End
string
/^([01]\d|2[0-3]):[0-5]\d$/
team_id
required
Any of:
string
acknowledged_mode
required
Any of:
string
acknowledged_at
required
Any of:
string format: date-time
governor
required
CcDialerGovernor

The abandon governor, with the formula’s numbers (PRD §6 “show the formula”).

object
state
required
State
string
Allowed values: normal one_to_one paused
changed_at
required
Any of:
string format: date-time
answered_30d
required
Answered 30D
integer
abandoned_30d
required
Abandoned 30D
integer
rate_30d
required
Rate 30D
number
answered_hour
required
Answered Hour
integer
abandoned_hour
required
Abandoned Hour
integer
rate_hour
required
Rate Hour
number
target
required
Target
number
ceiling
required
Ceiling
number
may_resume
required
May Resume
boolean
explanation
required
Explanation
string
lists
required
Lists
Array<object>
CcDialerListSummary
object
id
required
Id
string
name
required
Name
string
source
required
Source
string
Allowed values: csv crm_view
priority
required
Priority
integer
active
required
Active
boolean
national_dnc_scrubbed_at
required
Any of:
string format: date-time
scrub_stale
required
Scrub Stale
boolean
counts
required
Counts
object
key
additional properties
integer
recycle_generation
required
Recycle Generation
integer
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
remaining
required
Remaining
object
key
additional properties
integer
compliance_summary
required
Compliance Summary
Array<string>
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
switches
required
CcDialerSwitches
object
dialer
required
Dialer
boolean
paced
required
Paced
boolean
predictive
required
Predictive
boolean
modes_available
required
Modes Available
Array<string>
Allowed values: preview progressive power predictive
numbers
required
Numbers
Array<object>
CcDialerNumber
object
id
required
Id
string
phone_e164
required
Phone E164
string
state
required
Any of:
string
acknowledgement
required
CcDialerAcknowledgement
object
version
Version
string
default: cc-dialer-paced-ack/2026-10-05
text
Text
string
default: I am enabling a dialing mode that may call more people than there are free agents. I confirm that this campaign's leads come from a list we own, that we hold the consent this campaign's purpose requires, and that I understand Vocapable will hold the campaign's abandoned calls at or below 3% over every 30 days by slowing to one call per agent at 2.5% and pausing at 3%, and will play our abandon message with an opt-out to every call it cannot connect within 2 seconds.
can_manage
required
Can Manage
boolean
can_acknowledge
required
Can Acknowledge
boolean
Example
{
  "data": [
    {
      "status": "draft",
      "mode": "preview",
      "purpose": "marketing",
      "dispositions": [
        {
          "outcome_class": "contact"
        }
      ],
      "governor": {
        "state": "normal"
      },
      "lists": [
        {
          "source": "csv"
        }
      ]
    }
  ],
  "modes_available": [
    "preview"
  ],
  "acknowledgement": {
    "version": "cc-dialer-paced-ack/2026-10-05",
    "text": "I am enabling a dialing mode that may call more people than there are free agents. I confirm that this campaign's leads come from a list we own, that we hold the consent this campaign's purpose requires, and that I understand Vocapable will hold the campaign's abandoned calls at or below 3% over every 30 days by slowing to one call per agent at 2.5% and pausing at 3%, and will play our abandon message with an opt-out to every call it cannot connect within 2 seconds."
  }
}