Describe Campaign

connectcampaignservicev2_describe_campaign

R Documentation

Describes the specific campaign

Description

Describes the specific campaign.

Usage

connectcampaignservicev2_describe_campaign(id)

Arguments

id	[required] Identifier representing a Campaign

Value

A list with the following syntax:

list(
  campaign = list(
    id = "string",
    arn = "string",
    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"
    )
  )
)

Request syntax

svc$describe_campaign(
  id = "string"
)