API reference
CampaignContact
The CampaignContact object.
| Field | Type | Description |
|---|---|---|
attempts |
integer | Calls placed to them so far. |
callback_at |
string (date-time) or null | A time they asked to be called back at. |
campaign_id |
string (uuid) | |
conversation_id |
string (uuid) or null | Their latest conversation. |
created_at |
string (date-time) | |
disposition |
string or null | How the latest call ended on the line. One of: answered, no_answer, busy, declined, failed, unreachable, voicemail, voicemail_left. New words may be added. |
error |
string or null | Why the platform did not call them, when it did not. |
external_id |
string or null | |
id |
string (uuid) | |
metadata |
object | |
next_attempt_at |
string (date-time) or null | When they are next called, if queued. |
object |
campaign_contact |
|
status |
string | queued until their turn or their next try; dialing on a call; done once reached; exhausted when every try is used; failed when the platform refused to call them. One of: queued, dialing, done, failed, exhausted. New words may be added. |
timezone |
string or null | |
to_number |
string | |
variables |
object |