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, source, connectCampaignFlowArn, schedule,
  communicationTimeConfig, communicationLimitsOverride, tags)

Arguments

name

[required]

connectInstanceId

[required]

channelSubtypeConfig

[required]

source

connectCampaignFlowArn

schedule

communicationTimeConfig

communicationLimitsOverride

tags

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()
      ),
      defaultOutboundConfig = list(
        connectContactFlowId = "string",
        connectSourcePhoneNumber = "string",
        answerMachineDetectionConfig = list(
          enableAnswerMachineDetection = TRUE|FALSE,
          awaitAnswerMachinePrompt = TRUE|FALSE
        )
      )
    ),
    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"
      )
    )
  ),
  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"
  ),
  communicationTimeConfig = list(
    localTimeZoneConfig = list(
      defaultTimeZone = "string",
      localTimeZoneDetection = list(
        "ZIP_CODE"|"AREA_CODE"
      )
    ),
    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"
          )
        )
      )
    )
  ),
  communicationLimitsOverride = list(
    allChannelSubtypes = list(
      communicationLimitsList = list(
        list(
          maxCountPerRecipient = 123,
          frequency = 123,
          unit = "DAY"
        )
      )
    )
  ),
  tags = list(
    "string"
  )
)