API reference
Campaign
The Campaign object.
| Field | Type | Description |
|---|---|---|
agent_id |
string (uuid) | |
callbacks |
CampaignCallbacksObject | |
calling_hours |
CampaignCallingHoursObject | |
contacts |
CampaignCounts | |
created_at |
string (date-time) | |
finished_at |
string (date-time) or null | |
id |
string (uuid) | |
livemode |
boolean | |
name |
string | |
object |
campaign |
|
pacing |
CampaignPacingObject | |
paused_reason |
string or null | Why it paused itself, when it did. |
phone_number_id |
string (uuid) or null | |
project_id |
string (uuid) | |
start_at |
string (date-time) or null | When a draft will start by itself. |
started_at |
string (date-time) or null | |
status |
string | draft until it starts; running while it calls; paused, by you or because it could not go on — paused_reason says which; completed once nobody is left to call; cancelled if you stopped it. One of: draft, running, paused, completed, cancelled. New words may be added. |
voicemail |
CampaignVoicemailObject |