Package-level declarations
Types
Link copied to clipboard
class CampaignAgentlessConfig
Agentless config
Link copied to clipboard
data class CampaignAnswerMachineDetectionConfig(val awaitAnswerMachinePrompt: Boolean? = null, val enableAnswerMachineDetection: Boolean)
The configuration used for answering machine detection during outbound calls
Link copied to clipboard
data class CampaignChannelSubtypeConfig(val email: CampaignEmailChannelSubtypeConfig? = null, val sms: CampaignSmsChannelSubtypeConfig? = null, val telephony: CampaignTelephonyChannelSubtypeConfig? = null)
The possible types of channel subtype config parameters
Link copied to clipboard
data class CampaignCommunicationLimit(val frequency: Int, val maxCountPerRecipient: Int, val unit: CampaignCommunicationLimitTimeUnit)
Communication Limit
Link copied to clipboard
data class CampaignCommunicationLimits(val communicationLimitList: List<CampaignCommunicationLimit>? = null)
Communication limits
Link copied to clipboard
data class CampaignCommunicationLimitsConfig(val allChannelsSubtypes: CampaignCommunicationLimits? = null)
Communication limits config
Link copied to clipboard
data class CampaignCommunicationTimeConfig(val email: CampaignTimeWindow? = null, val localTimeZoneConfig: CampaignLocalTimeZoneConfig, val sms: CampaignTimeWindow? = null, val telephony: CampaignTimeWindow? = null)
Campaign communication time config
Link copied to clipboard
data class CampaignDailyHour(val key: CampaignDayOfWeek? = null, val value: List<CampaignTimeRange>? = null)
Daily Hour
Link copied to clipboard
data class CampaignEmailChannelSubtypeConfig(val capacity: Double? = null, val defaultOutboundConfig: CampaignEmailOutboundConfig, val outboundMode: CampaignEmailOutboundMode)
Email Channel Subtype config
Link copied to clipboard
data class CampaignEmailOutboundConfig(val connectSourceEmailAddress: String, val sourceEmailAddressDisplayName: String? = null, val wisdomTemplateArn: String)
Default SMS outbound config
Link copied to clipboard
Email Outbound Mode
Link copied to clipboard
The event trigger of the campaign
Link copied to clipboard
data class CampaignLocalTimeZoneConfig(val defaultTimeZone: String? = null, val localTimeZoneDetection: List<CampaignLocalTimeZoneDetectionType>? = null)
Local time zone config
Link copied to clipboard
Open Hours config
Link copied to clipboard
Predictive config
Link copied to clipboard
Progressive config
Link copied to clipboard
data class CampaignRestrictedPeriod(val endDate: String, val name: String? = null, val startDate: String)
Restricted period
Link copied to clipboard
data class CampaignRestrictedPeriods(val restrictedPeriodList: List<CampaignRestrictedPeriod>? = null)
Restricted period config
Link copied to clipboard
data class CampaignSchedule(val endTime: String, val refreshFrequency: String? = null, val startTime: String)
Campaign schedule
Link copied to clipboard
data class CampaignSmsChannelSubtypeConfig(val capacity: Double? = null, val defaultOutboundConfig: CampaignSmsOutboundConfig, val outboundMode: CampaignSmsOutboundMode)
SMS Channel Subtype config
Link copied to clipboard
data class CampaignSmsOutboundConfig(val connectSourcePhoneNumberArn: String, val wisdomTemplateArn: String)
Default SMS outbound config
Link copied to clipboard
SMS Outbound Mode
Link copied to clipboard
data class CampaignSource(val customerProfilesSegmentArn: String? = null, val eventTrigger: CampaignEventTrigger? = null)
The possible source of the campaign
Link copied to clipboard
data class CampaignTelephonyChannelSubtypeConfig(val capacity: Double? = null, val connectQueueId: String? = null, val defaultOutboundConfig: CampaignTelephonyOutboundConfig, val outboundMode: CampaignTelephonyOutboundMode)
Telephony Channel Subtype config
Link copied to clipboard
data class CampaignTelephonyOutboundConfig(val answerMachineDetectionConfig: CampaignAnswerMachineDetectionConfig? = null, val connectContactFlowId: String, val connectSourcePhoneNumber: String? = null)
Default Telephone Outbound config
Link copied to clipboard
data class CampaignTelephonyOutboundMode(val agentlessConfig: CampaignAgentlessConfig? = null, val predictiveConfig: CampaignPredictiveConfig? = null, val progressiveConfig: CampaignProgressiveConfig? = null)
Telephony Outbound Mode
Link copied to clipboard
Time range in 24 hour format
Link copied to clipboard
data class CampaignTimeWindow(val openHours: CampaignOpenHours, val restrictedPeriods: CampaignRestrictedPeriods? = null)
Time window config
Link copied to clipboard
data class GetCampaignResult(val arn: String? = null, val channelSubtypeConfig: CampaignChannelSubtypeConfig? = null, val communicationLimitsOverride: CampaignCommunicationLimitsConfig? = null, val communicationTimeConfig: CampaignCommunicationTimeConfig? = null, val connectCampaignFlowArn: String? = null, val name: String? = null, val schedule: CampaignSchedule? = null, val source: CampaignSource? = null, val tags: List<Tag>? = null)