VocalDocscontracts 1.65.0

CampaignEnrollment

One Contact enrolled in a Campaign (1.65.0): its arm, status, disposition, attempts and Calls, identifiers and codes, and its variables only on include=content.

An object with 21 fields.

Fields

FieldTypeRequiredDescription
all_attemptsintegeryesEvery attempt, those that never rang included.
armCampaignArmKeyyes
attemptsintegeryesAttempts that reached ringing.
campaign_idCampaignIdyes
completed_atTimestamp or nullyes
contact_idContactIdyes
created_atTimestampyes
dispositionCampaignDisposition or nullyesThe terminal disposition of a completed enrollment; null otherwise.
idCampaignEnrollmentIdyes
ineligible_codeCampaignIneligibleCode or nullyes
last_call_idCallId or nullyes
last_ended_reasonEndedReason or nullyes
live_call_idCallId or nullyes
next_attempt_atTimestamp or nullyes
object"campaign_enrollment"yes
outcome_idOutcomeId or nullyes
phone_number_idPhoneNumberId or nullyesThe number assigned at the first permit, sticky for the enrollment.
priorityintegeryes
process_idProcessInstanceId or nullyesThe contact instance, started with the first permit; null before it.
statusCampaignEnrollmentStatusyes
variablesobject or nullyesPer-enrollment variables. Content; null unless the read names include=content.

Used by

The operations whose parameters, request body or responses name this shape directly.