Package com.mypurecloud.sdk.v2.model

Class Campaign

java.lang.Object
com.mypurecloud.sdk.v2.model.Campaign
All Implemented Interfaces:
Serializable
public class Campaign extends Object implements Serializable
Campaign
See Also:

  • Constructor Details

    • Campaign

      public Campaign()

    • Campaign

      public Campaign(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public Campaign name(String name)
      The name of the Campaign.

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getDateCreated

      public Date getDateCreated()

    • getDateModified

      public Date getDateModified()

    • version

      public Campaign version(Integer version)
      Required for updates, must match the version number of the most recent update

    • getVersion

      public Integer getVersion()

    • setVersion

      public void setVersion(Integer version)

    • contactList

      public Campaign contactList(DomainEntityRef contactList)
      The ContactList for this Campaign to dial.

    • getContactList

      public DomainEntityRef getContactList()

    • setContactList

      public void setContactList(DomainEntityRef contactList)

    • queue

      public Campaign queue(DomainEntityRef queue)
      The Queue for this Campaign to route calls to. Required for all dialing modes except agentless.

    • getQueue

      public DomainEntityRef getQueue()

    • setQueue

      public void setQueue(DomainEntityRef queue)

    • dialingMode

      public Campaign dialingMode(Campaign.DialingModeEnum dialingMode)
      The strategy this Campaign will use for dialing.

    • getDialingMode

      public Campaign.DialingModeEnum getDialingMode()

    • setDialingMode

      public void setDialingMode(Campaign.DialingModeEnum dialingMode)

    • script

      public Campaign script(DomainEntityRef script)
      The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless.

    • getScript

      public DomainEntityRef getScript()

    • setScript

      public void setScript(DomainEntityRef script)

    • edgeGroup

      public Campaign edgeGroup(DomainEntityRef edgeGroup)
      The EdgeGroup that will place the calls. Required for all dialing modes except preview.

    • getEdgeGroup

      public DomainEntityRef getEdgeGroup()

    • setEdgeGroup

      public void setEdgeGroup(DomainEntityRef edgeGroup)

    • site

      public Campaign site(DomainEntityRef site)
      The identifier of the site to be used for dialing; can be set in place of an edge group.

    • getSite

      public DomainEntityRef getSite()

    • setSite

      public void setSite(DomainEntityRef site)

    • campaignStatus

      public Campaign campaignStatus(Campaign.CampaignStatusEnum campaignStatus)
      The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates.

    • getCampaignStatus

      public Campaign.CampaignStatusEnum getCampaignStatus()

    • setCampaignStatus

      public void setCampaignStatus(Campaign.CampaignStatusEnum campaignStatus)

    • phoneColumns

      public Campaign phoneColumns(List<PhoneColumn> phoneColumns)
      The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.

    • getPhoneColumns

      public List<PhoneColumn> getPhoneColumns()

    • setPhoneColumns

      public void setPhoneColumns(List<PhoneColumn> phoneColumns)

    • abandonRate

      public Campaign abandonRate(Double abandonRate)
      The targeted compliance abandon rate percentage. Required for power and predictive campaigns.

    • getAbandonRate

      public Double getAbandonRate()

    • setAbandonRate

      public void setAbandonRate(Double abandonRate)

    • dncLists

      public Campaign dncLists(List<DomainEntityRef> dncLists)
      DncLists for this Campaign to check before placing a call.

    • getDncLists

      public List<DomainEntityRef> getDncLists()

    • setDncLists

      public void setDncLists(List<DomainEntityRef> dncLists)

    • callableTimeSet

      public Campaign callableTimeSet(DomainEntityRef callableTimeSet)
      The callable time set for this campaign to check before placing a call.

    • getCallableTimeSet

      public DomainEntityRef getCallableTimeSet()

    • setCallableTimeSet

      public void setCallableTimeSet(DomainEntityRef callableTimeSet)

    • callAnalysisResponseSet

      public Campaign callAnalysisResponseSet(DomainEntityRef callAnalysisResponseSet)
      The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview.

    • getCallAnalysisResponseSet

      public DomainEntityRef getCallAnalysisResponseSet()

    • setCallAnalysisResponseSet

      public void setCallAnalysisResponseSet(DomainEntityRef callAnalysisResponseSet)

    • getErrors

      public List<RestErrorDetail> getErrors()

    • callerName

      public Campaign callerName(String callerName)
      The caller id name to be displayed on the outbound call.

    • getCallerName

      public String getCallerName()

    • setCallerName

      public void setCallerName(String callerName)

    • callerAddress

      public Campaign callerAddress(String callerAddress)
      The caller id phone number to be displayed on the outbound call.

    • getCallerAddress

      public String getCallerAddress()

    • setCallerAddress

      public void setCallerAddress(String callerAddress)

    • outboundLineCount

      public Campaign outboundLineCount(Integer outboundLineCount)
      The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless.

    • getOutboundLineCount

      public Integer getOutboundLineCount()

    • setOutboundLineCount

      public void setOutboundLineCount(Integer outboundLineCount)

    • ruleSets

      public Campaign ruleSets(List<DomainEntityRef> ruleSets)
      Rule sets to be applied while this campaign is dialing.

    • getRuleSets

      public List<DomainEntityRef> getRuleSets()

    • setRuleSets

      public void setRuleSets(List<DomainEntityRef> ruleSets)

    • skipPreviewDisabled

      public Campaign skipPreviewDisabled(Boolean skipPreviewDisabled)
      Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns.

    • getSkipPreviewDisabled

      public Boolean getSkipPreviewDisabled()

    • setSkipPreviewDisabled

      public void setSkipPreviewDisabled(Boolean skipPreviewDisabled)

    • previewTimeOutSeconds

      public Campaign previewTimeOutSeconds(Long previewTimeOutSeconds)
      The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns.

    • getPreviewTimeOutSeconds

      public Long getPreviewTimeOutSeconds()

    • setPreviewTimeOutSeconds

      public void setPreviewTimeOutSeconds(Long previewTimeOutSeconds)

    • alwaysRunning

      public Campaign alwaysRunning(Boolean alwaysRunning)
      Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually.

    • getAlwaysRunning

      public Boolean getAlwaysRunning()

    • setAlwaysRunning

      public void setAlwaysRunning(Boolean alwaysRunning)

    • contactSort

      public Campaign contactSort(ContactSort contactSort)
      The order in which to sort contacts for dialing, based on a column.

    • getContactSort

      public ContactSort getContactSort()

    • setContactSort

      public void setContactSort(ContactSort contactSort)

    • contactSorts

      public Campaign contactSorts(List<ContactSort> contactSorts)
      The order in which to sort contacts for dialing, based on up to four columns.

    • getContactSorts

      public List<ContactSort> getContactSorts()

    • setContactSorts

      public void setContactSorts(List<ContactSort> contactSorts)

    • noAnswerTimeout

      public Campaign noAnswerTimeout(Integer noAnswerTimeout)
      How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns.

    • getNoAnswerTimeout

      public Integer getNoAnswerTimeout()

    • setNoAnswerTimeout

      public void setNoAnswerTimeout(Integer noAnswerTimeout)

    • callAnalysisLanguage

      public Campaign callAnalysisLanguage(String callAnalysisLanguage)
      The language the edge will use to analyze the call.

    • getCallAnalysisLanguage

      public String getCallAnalysisLanguage()

    • setCallAnalysisLanguage

      public void setCallAnalysisLanguage(String callAnalysisLanguage)

    • priority

      public Campaign priority(Integer priority)
      The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest.

    • getPriority

      public Integer getPriority()

    • setPriority

      public void setPriority(Integer priority)

    • contactListFilters

      public Campaign contactListFilters(List<DomainEntityRef> contactListFilters)
      Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.

    • getContactListFilters

      public List<DomainEntityRef> getContactListFilters()

    • setContactListFilters

      public void setContactListFilters(List<DomainEntityRef> contactListFilters)

    • division

      public Campaign division(DomainEntityRef division)
      The division this campaign belongs to.

    • getDivision

      public DomainEntityRef getDivision()

    • setDivision

      public void setDivision(DomainEntityRef division)

    • agentOwnedColumn

      public Campaign agentOwnedColumn(String agentOwnedColumn)
      Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns.

    • getAgentOwnedColumn

      public String getAgentOwnedColumn()

    • setAgentOwnedColumn

      public void setAgentOwnedColumn(String agentOwnedColumn)

    • dynamicContactQueueingSettings

      public Campaign dynamicContactQueueingSettings(DynamicContactQueueingSettings dynamicContactQueueingSettings)
      Settings for dynamic queueing of contacts.

    • getDynamicContactQueueingSettings

      public DynamicContactQueueingSettings getDynamicContactQueueingSettings()

    • setDynamicContactQueueingSettings

      public void setDynamicContactQueueingSettings(DynamicContactQueueingSettings dynamicContactQueueingSettings)

    • skillColumns

      public Campaign skillColumns(List<String> skillColumns)
      The skill columns on the ContactList that this Campaign should take into account when dialing

    • getSkillColumns

      public List<String> getSkillColumns()

    • setSkillColumns

      public void setSkillColumns(List<String> skillColumns)

    • previewAutoEnd

      public Campaign previewAutoEnd(Boolean previewAutoEnd)
      Option to enable preview auto end

    • getPreviewAutoEnd

      public Boolean getPreviewAutoEnd()

    • setPreviewAutoEnd

      public void setPreviewAutoEnd(Boolean previewAutoEnd)

    • maxCallsPerAgent

      public Campaign maxCallsPerAgent(Integer maxCallsPerAgent)
      The maximum number of calls that can be placed per agent on this campaign

    • getMaxCallsPerAgent

      public Integer getMaxCallsPerAgent()

    • setMaxCallsPerAgent

      public void setMaxCallsPerAgent(Integer maxCallsPerAgent)

    • maxCallsPerAgentDecimal

      public Campaign maxCallsPerAgentDecimal(Double maxCallsPerAgentDecimal)
      The maximum number of calls that can be placed per agent on this campaign with decimal precision

    • getMaxCallsPerAgentDecimal

      public Double getMaxCallsPerAgentDecimal()

    • setMaxCallsPerAgentDecimal

      public void setMaxCallsPerAgentDecimal(Double maxCallsPerAgentDecimal)

    • callbackAutoAnswer

      public Campaign callbackAutoAnswer(Boolean callbackAutoAnswer)
      The option manages the auto-answer callback calls

    • getCallbackAutoAnswer

      public Boolean getCallbackAutoAnswer()

    • setCallbackAutoAnswer

      public void setCallbackAutoAnswer(Boolean callbackAutoAnswer)

    • dynamicLineBalancingSettings

      public Campaign dynamicLineBalancingSettings(DynamicLineBalancingSettings dynamicLineBalancingSettings)
      Dynamic line balancing settings

    • getDynamicLineBalancingSettings

      public DynamicLineBalancingSettings getDynamicLineBalancingSettings()

    • setDynamicLineBalancingSettings

      public void setDynamicLineBalancingSettings(DynamicLineBalancingSettings dynamicLineBalancingSettings)

    • diagnosticsSettings

      public Campaign diagnosticsSettings(DiagnosticsSettings diagnosticsSettings)
      Campaign diagnostics settings

    • getDiagnosticsSettings

      public DiagnosticsSettings getDiagnosticsSettings()

    • setDiagnosticsSettings

      public void setDiagnosticsSettings(DiagnosticsSettings diagnosticsSettings)

    • getSelfUri

      public String getSelfUri()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object