Skip to content
vocapable.Docs

Create a campaign (preview by default)

POST
/v1/workspace/contact-center/dialer/campaigns
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/contact-center/dialer/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "purpose": "marketing", "seller_name": "example", "abandon_message": "example", "opt_out_digit": "9", "callback_number_id": "example", "default_number_id": "example", "local_presence": true, "ring_seconds": 25, "preview_seconds": 1, "amd_enabled": true, "voicemail_drop_id": "example", "script": "", "dispositions": [ { "key": "example", "label": "example", "outcome_class": "contact", "retry_after_minutes": 1, "max_attempts": 1 } ], "best_windows": [ { "start": "example", "end": "example" } ], "team_id": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CcDialerCampaignSettings

What an owner or manager configures. The mode is changed on its own route (paced modes need the owner’s acknowledgement).

object
name
required
Name
string
>= 1 characters <= 80 characters
description
Any of:
string
<= 500 characters
purpose
Purpose
string
default: marketing
Allowed values: marketing informational transactional
seller_name
required
Seller Name
string
>= 1 characters <= 80 characters
abandon_message
Any of:
string
<= 600 characters
opt_out_digit
Opt Out Digit
string
default: 9 /^[0-9]$/
callback_number_id
Any of:
string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/
default_number_id
Any of:
string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/
local_presence
Local Presence
boolean
default: true
ring_seconds
Ring Seconds
integer
default: 25 >= 15 <= 60
preview_seconds
Any of:
integer
>= 10 <= 120
amd_enabled
Amd Enabled
boolean
default: true
voicemail_drop_id
Any of:
string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/
script
Script
string
"" <= 20000 characters
dispositions
Dispositions
Array<object>
<= 30 items
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
Best Windows
Array<object>
<= 4 items
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
Any of:
string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
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
Example
{
  "status": "draft",
  "mode": "preview",
  "purpose": "marketing",
  "dispositions": [
    {
      "outcome_class": "contact"
    }
  ],
  "governor": {
    "state": "normal"
  },
  "lists": [
    {
      "source": "csv"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}