Create Campaign

connectcampaignservicev2_create_campaign

R Documentation

Creates a campaign for the specified Amazon Connect account

Description

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

Usage

connectcampaignservicev2_create_campaign(name, connectInstanceId,
  channelSubtypeConfig, type, source, connectCampaignFlowArn, schedule,
  entryLimitsConfig, communicationTimeConfig, communicationLimitsOverride,
  tags)

Arguments

name	[required] The name of an Amazon Connect Campaign name.
connectInstanceId	[required] Amazon Connect Instance Id
channelSubtypeConfig	Campaign Channel Subtype config
type	The type of campaign externally exposed in APIs.
source	Source of the campaign
connectCampaignFlowArn	Amazon Resource Names(ARN)
schedule	Campaign schedule
entryLimitsConfig	Campaign entry limits config
communicationTimeConfig	Campaign communication time config
communicationLimitsOverride	Communication limits config
tags	Tag map with key and value.

Value

A list with the following syntax:

list(
  id = "string",
  arn = "string",
  tags = list(
    "string"
  )
)

Request syntax

svc$create_campaign(
  name = "string",
  connectInstanceId = "string",
  channelSubtypeConfig = list(
    telephony = list(
      capacity = 123.0,
      connectQueueId = "string",
      outboundMode = list(
        progressive = list(
          bandwidthAllocation = 123.0
        ),
        predictive = list(
          bandwidthAllocation = 123.0
        ),
        agentless = list(),
        preview = list(
          bandwidthAllocation = 123.0,
          timeoutConfig = list(
            durationInSeconds = 123
          ),
          agentActions = list(
            "DISCARD"
          )
        )
      ),
      defaultOutboundConfig = list(
        connectContactFlowId = "string",
        connectSourcePhoneNumber = "string",
        answerMachineDetectionConfig = list(
          enableAnswerMachineDetection = TRUE|FALSE,
          awaitAnswerMachinePrompt = TRUE|FALSE
        ),
        ringTimeout = 123
      )
    ),
    sms = list(
      capacity = 123.0,
      outboundMode = list(
        agentless = list()
      ),
      defaultOutboundConfig = list(
        connectSourcePhoneNumberArn = "string",
        wisdomTemplateArn = "string"
      )
    ),
    email = list(
      capacity = 123.0,
      outboundMode = list(
        agentless = list()
      ),
      defaultOutboundConfig = list(
        connectSourceEmailAddress = "string",
        sourceEmailAddressDisplayName = "string",
        wisdomTemplateArn = "string"
      )
    ),
    whatsApp = list(
      capacity = 123.0,
      outboundMode = list(
        agentless = list()
      ),
      defaultOutboundConfig = list(
        connectSourcePhoneNumberArn = "string",
        wisdomTemplateArn = "string"
      )
    )
  ),
  type = "MANAGED"|"JOURNEY",
  source = list(
    customerProfilesSegmentArn = "string",
    eventTrigger = list(
      customerProfilesDomainArn = "string"
    )
  ),
  connectCampaignFlowArn = "string",
  schedule = list(
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    endTime = as.POSIXct(
      "2015-01-01"
    ),
    refreshFrequency = "string"
  ),
  entryLimitsConfig = list(
    maxEntryCount = 123,
    minEntryInterval = "string"
  ),
  communicationTimeConfig = list(
    localTimeZoneConfig = list(
      defaultTimeZone = "string",
      localTimeZoneDetection = list(
        "ZIP_CODE"|"AREA_CODE"
      ),
      localTimeZoneDetectionScope = "PRIMARY_ONLY"|"ALL_AVAILABLE"
    ),
    telephony = list(
      openHours = list(
        dailyHours = list(
          list(
            list(
              startTime = "string",
              endTime = "string"
            )
          )
        )
      ),
      restrictedPeriods = list(
        restrictedPeriodList = list(
          list(
            name = "string",
            startDate = "string",
            endDate = "string"
          )
        )
      )
    ),
    sms = list(
      openHours = list(
        dailyHours = list(
          list(
            list(
              startTime = "string",
              endTime = "string"
            )
          )
        )
      ),
      restrictedPeriods = list(
        restrictedPeriodList = list(
          list(
            name = "string",
            startDate = "string",
            endDate = "string"
          )
        )
      )
    ),
    email = list(
      openHours = list(
        dailyHours = list(
          list(
            list(
              startTime = "string",
              endTime = "string"
            )
          )
        )
      ),
      restrictedPeriods = list(
        restrictedPeriodList = list(
          list(
            name = "string",
            startDate = "string",
            endDate = "string"
          )
        )
      )
    ),
    whatsApp = list(
      openHours = list(
        dailyHours = list(
          list(
            list(
              startTime = "string",
              endTime = "string"
            )
          )
        )
      ),
      restrictedPeriods = list(
        restrictedPeriodList = list(
          list(
            name = "string",
            startDate = "string",
            endDate = "string"
          )
        )
      )
    )
  ),
  communicationLimitsOverride = list(
    allChannelSubtypes = list(
      communicationLimitsList = list(
        list(
          maxCountPerRecipient = 123,
          frequency = 123,
          unit = "DAY"
        )
      )
    ),
    instanceLimitsHandling = "OPT_IN"|"OPT_OUT"
  ),
  tags = list(
    "string"
  )
)