Skip to content
Vocapable Developers

Read one campaign

GET
/v1/campaigns/{campaign_id}
curl --request GET \
  --url https://api.vocapable.com/v1/campaigns/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
campaign_id
required
Campaign Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Campaign

One campaign in full, schedule included.

object
id
required
Id
string
name
required
Name
string
status
required
CampaignStatus
string
Allowed values: draft scrubbing ready running paused completed cancelled
agent_definition_id
required
Agent Definition Id
string
agent_version_id
Any of:
string
target
required
CampaignTarget

V1 campaigns target a contact list; a segment_id target joins at P2.

object
contact_list_id
required
Contact List Id
string
number_pool_id
required
Number Pool Id
string
telephony_account_id
required
Telephony Account Id
string
compliance_profile_id
Any of:
string
scrub_run_id
Any of:
string
max_attempts_per_contact
required
Max Attempts Per Contact
integer
concurrency_cap
Any of:
integer
contacts_total
required
Contacts Total
integer
dialed
required
Dialed
integer
connected
required
Connected
integer
completed_goal
required
Completed Goal
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
retry_policy
required
RetryPolicy

Disposition-driven backoff: the spacing ladder and the retriable dispositions.

object
backoff_minutes
Backoff Minutes
Array<integer>
retry_dispositions
Retry Dispositions
Array<string>
Allowed values: completed_goal completed_no_goal answered_incomplete voicemail_machine no_answer busy failed opt_out wrong_person_opt_out dnc_hit scrub_blocked blocked_by_policy abandoned_no_slot inbound_unavailable browser_unavailable
voicemail_drop
VoicemailDropPolicy

Whether this program leaves artificial-voice voicemail (ADR-0023).

One field, and it is an election rather than a configuration: what is said belongs to the pinned agent version, and how many times is not a knob at all. A drop is terminal

  • the attempt disposes voicemail_machine and never re-enters the retry ladder - so a contact receives at most one message per campaign by construction, not by a counter a caller could raise.

Launching with this enabled additionally requires the executed Cold Outreach & Data Provenance Waiver, and the waiver is re-checked again at the instant of every drop: a campaign runs for days and a waiver version bump re-arms the gate by design.

object
enabled
Enabled
boolean
goal
Goal
object
key
additional properties
any
schedule
Any of:
CampaignSchedule

Per-weekday calling windows plus the campaign’s calendar bounds.

Dates, not instants: they bound the campaign in the callee’s local day, and the policy layer intersects the windows with jurisdictional quiet hours - the stricter wins.

object
calling_windows
Calling Windows
object
key
additional properties
Array<object>
CallingWindow

One local-time window on one weekday.

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$/
start_date
Any of:
string format: date
end_date
Any of:
string format: date
paused_dates
Paused Dates
Array<string>
Example
{
  "status": "draft",
  "retry_policy": {
    "retry_dispositions": [
      "completed_goal"
    ]
  },
  "voicemail_drop": {
    "enabled": false
  }
}

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": {}
    }
  ]
}