Package com.mypurecloud.sdk.v2.model

Class DialerCampaignConfigChangeCampaign

java.lang.Object

com.mypurecloud.sdk.v2.model.DialerCampaignConfigChangeCampaign

All Implemented Interfaces:

Serializable

public class DialerCampaignConfigChangeCampaign
extends Object
implements Serializable

DialerCampaignConfigChangeCampaign

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DialerCampaignConfigChangeCampaign.CampaignStatusEnum	Gets or Sets campaignStatus
static enum	DialerCampaignConfigChangeCampaign.DialingModeEnum	dialing mode of the campaign

Constructor Summary

Constructors

Constructor	Description
DialerCampaignConfigChangeCampaign()
DialerCampaignConfigChangeCampaign(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
DialerCampaignConfigChangeCampaign	abandonRate(BigDecimal abandonRate)	the targeted abandon rate percentage
DialerCampaignConfigChangeCampaign	additionalProperties(Map<String,Object> additionalProperties)
DialerCampaignConfigChangeCampaign	agentOwnedColumn(String agentOwnedColumn)	For Preview Campaigns.
DialerCampaignConfigChangeCampaign	callableTimeSet(DialerCampaignConfigChangeUriReference callableTimeSet)	A UriReference for a resource
DialerCampaignConfigChangeCampaign	callAnalysisLanguage(String callAnalysisLanguage)	The language the edge will use to analyze the call
DialerCampaignConfigChangeCampaign	callAnalysisResponseSet(DialerCampaignConfigChangeUriReference callAnalysisResponseSet)	A UriReference for a resource
DialerCampaignConfigChangeCampaign	callerAddress(String callerAddress)	caller id phone number to be displayed on the outbound call
DialerCampaignConfigChangeCampaign	callerName(String callerName)	caller id name to be displayed on the outbound call
DialerCampaignConfigChangeCampaign	campaignStatus(DialerCampaignConfigChangeCampaign.CampaignStatusEnum campaignStatus)
DialerCampaignConfigChangeCampaign	contactList(DialerCampaignConfigChangeUriReference contactList)
DialerCampaignConfigChangeCampaign	contactListFilters(List<DialerCampaignConfigChangeUriReference> contactListFilters)	List of contact filters
DialerCampaignConfigChangeCampaign	contactSort(DialerCampaignConfigChangeContactSort contactSort)
DialerCampaignConfigChangeCampaign	contactSorts(List<DialerCampaignConfigChangeContactSort> contactSorts)	List of contact sort objects.
DialerCampaignConfigChangeCampaign	dateCreated(Date dateCreated)	Creation time of the entity
DialerCampaignConfigChangeCampaign	dateModified(Date dateModified)	Last modified time of the entity
DialerCampaignConfigChangeCampaign	dialingMode(DialerCampaignConfigChangeCampaign.DialingModeEnum dialingMode)	dialing mode of the campaign
DialerCampaignConfigChangeCampaign	division(DialerCampaignConfigChangeUriReference division)	A UriReference for a resource
DialerCampaignConfigChangeCampaign	dncLists(List<DialerCampaignConfigChangeUriReference> dncLists)	identifiers of the do not call lists
DialerCampaignConfigChangeCampaign	edgeGroup(DialerCampaignConfigChangeUriReference edgeGroup)	A UriReference for a resource
boolean	equals(Object o)
DialerCampaignConfigChangeCampaign	errors(List<DialerCampaignConfigChangeRestErrorDetail> errors)	a list of current error conditions associated with the campaign
BigDecimal	getAbandonRate()
Map<String,Object>	getAdditionalProperties()
String	getAgentOwnedColumn()
DialerCampaignConfigChangeUriReference	getCallableTimeSet()
String	getCallAnalysisLanguage()
DialerCampaignConfigChangeUriReference	getCallAnalysisResponseSet()
String	getCallerAddress()
String	getCallerName()
DialerCampaignConfigChangeCampaign.CampaignStatusEnum	getCampaignStatus()
DialerCampaignConfigChangeUriReference	getContactList()
List<DialerCampaignConfigChangeUriReference>	getContactListFilters()
DialerCampaignConfigChangeContactSort	getContactSort()
List<DialerCampaignConfigChangeContactSort>	getContactSorts()
Date	getDateCreated()
Date	getDateModified()
DialerCampaignConfigChangeCampaign.DialingModeEnum	getDialingMode()
DialerCampaignConfigChangeUriReference	getDivision()
List<DialerCampaignConfigChangeUriReference>	getDncLists()
DialerCampaignConfigChangeUriReference	getEdgeGroup()
List<DialerCampaignConfigChangeRestErrorDetail>	getErrors()
String	getId()
String	getName()
Long	getNoAnswerTimeout()
Long	getOutboundLineCount()
List<DialerCampaignConfigChangePhoneColumn>	getPhoneColumns()
Long	getPreviewTimeOutSeconds()
Long	getPriority()
DialerCampaignConfigChangeUriReference	getQueue()
List<DialerCampaignConfigChangeUriReference>	getRuleSets()
DialerCampaignConfigChangeUriReference	getScript()
Boolean	getSingleNumberPreview()
DialerCampaignConfigChangeUriReference	getSite()
Boolean	getSkipPreviewDisabled()
Long	getVersion()
int	hashCode()
DialerCampaignConfigChangeCampaign	id(String id)	The globally unique identifier for the object.
DialerCampaignConfigChangeCampaign	name(String name)	The UI-visible name of the object
DialerCampaignConfigChangeCampaign	noAnswerTimeout(Long noAnswerTimeout)	for non-preview campaigns, how long to wait before dispositioning as 'no-answer', default 30 seconds
DialerCampaignConfigChangeCampaign	outboundLineCount(Long outboundLineCount)	for agentless campaigns, the number of outbound lines to be concurrently dialed
DialerCampaignConfigChangeCampaign	phoneColumns(List<DialerCampaignConfigChangePhoneColumn> phoneColumns)	the contact list phone columns to be called for the campaign
DialerCampaignConfigChangeCampaign	previewTimeOutSeconds(Long previewTimeOutSeconds)	for preview campaigns, number of seconds before a call will be automatically placed.
DialerCampaignConfigChangeCampaign	priority(Long priority)	The priority of this campaign relative to other campaigns
DialerCampaignConfigChangeCampaign	queue(DialerCampaignConfigChangeUriReference queue)	A UriReference for a resource
DialerCampaignConfigChangeCampaign	ruleSets(List<DialerCampaignConfigChangeUriReference> ruleSets)	identifiers of the rule sets
DialerCampaignConfigChangeCampaign	script(DialerCampaignConfigChangeUriReference script)	A UriReference for a resource
void	setAbandonRate(BigDecimal abandonRate)
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAgentOwnedColumn(String agentOwnedColumn)
void	setCallableTimeSet(DialerCampaignConfigChangeUriReference callableTimeSet)
void	setCallAnalysisLanguage(String callAnalysisLanguage)
void	setCallAnalysisResponseSet(DialerCampaignConfigChangeUriReference callAnalysisResponseSet)
void	setCallerAddress(String callerAddress)
void	setCallerName(String callerName)
void	setCampaignStatus(DialerCampaignConfigChangeCampaign.CampaignStatusEnum campaignStatus)
void	setContactList(DialerCampaignConfigChangeUriReference contactList)
void	setContactListFilters(List<DialerCampaignConfigChangeUriReference> contactListFilters)
void	setContactSort(DialerCampaignConfigChangeContactSort contactSort)
void	setContactSorts(List<DialerCampaignConfigChangeContactSort> contactSorts)
void	setDateCreated(Date dateCreated)
void	setDateModified(Date dateModified)
void	setDialingMode(DialerCampaignConfigChangeCampaign.DialingModeEnum dialingMode)
void	setDivision(DialerCampaignConfigChangeUriReference division)
void	setDncLists(List<DialerCampaignConfigChangeUriReference> dncLists)
void	setEdgeGroup(DialerCampaignConfigChangeUriReference edgeGroup)
void	setErrors(List<DialerCampaignConfigChangeRestErrorDetail> errors)
void	setId(String id)
void	setName(String name)
void	setNoAnswerTimeout(Long noAnswerTimeout)
void	setOutboundLineCount(Long outboundLineCount)
void	setPhoneColumns(List<DialerCampaignConfigChangePhoneColumn> phoneColumns)
void	setPreviewTimeOutSeconds(Long previewTimeOutSeconds)
void	setPriority(Long priority)
void	setQueue(DialerCampaignConfigChangeUriReference queue)
void	setRuleSets(List<DialerCampaignConfigChangeUriReference> ruleSets)
void	setScript(DialerCampaignConfigChangeUriReference script)
void	setSingleNumberPreview(Boolean singleNumberPreview)
void	setSite(DialerCampaignConfigChangeUriReference site)
void	setSkipPreviewDisabled(Boolean skipPreviewDisabled)
void	setVersion(Long version)
DialerCampaignConfigChangeCampaign	singleNumberPreview(Boolean singleNumberPreview)	for preview campaigns with multiple phone columns, indicator if one (true) or multiple (false) phone numbers will be available to call for each preview
DialerCampaignConfigChangeCampaign	site(DialerCampaignConfigChangeUriReference site)	A UriReference for a resource
DialerCampaignConfigChangeCampaign	skipPreviewDisabled(Boolean skipPreviewDisabled)	for preview campaigns, indicator of whether the agent can skip a preview without placing a call
String	toString()
DialerCampaignConfigChangeCampaign	version(Long version)	Required for updates, must match the version number of the most recent update

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DialerCampaignConfigChangeCampaign

public DialerCampaignConfigChangeCampaign()

DialerCampaignConfigChangeCampaign

public DialerCampaignConfigChangeCampaign(Boolean initWithEmptyList)

Method Details

contactList

public DialerCampaignConfigChangeCampaign contactList(DialerCampaignConfigChangeUriReference contactList)

getContactList

public DialerCampaignConfigChangeUriReference getContactList()

setContactList

public void setContactList(DialerCampaignConfigChangeUriReference contactList)

queue

public DialerCampaignConfigChangeCampaign queue(DialerCampaignConfigChangeUriReference queue)

A UriReference for a resource

getQueue

public DialerCampaignConfigChangeUriReference getQueue()

setQueue

public void setQueue(DialerCampaignConfigChangeUriReference queue)

dialingMode

public DialerCampaignConfigChangeCampaign dialingMode(DialerCampaignConfigChangeCampaign.DialingModeEnum dialingMode)

dialing mode of the campaign

getDialingMode

public DialerCampaignConfigChangeCampaign.DialingModeEnum getDialingMode()

setDialingMode

public void setDialingMode(DialerCampaignConfigChangeCampaign.DialingModeEnum dialingMode)

script

public DialerCampaignConfigChangeCampaign script(DialerCampaignConfigChangeUriReference script)

A UriReference for a resource

getScript

public DialerCampaignConfigChangeUriReference getScript()

setScript

public void setScript(DialerCampaignConfigChangeUriReference script)

edgeGroup

public DialerCampaignConfigChangeCampaign edgeGroup(DialerCampaignConfigChangeUriReference edgeGroup)

A UriReference for a resource

getEdgeGroup

public DialerCampaignConfigChangeUriReference getEdgeGroup()

setEdgeGroup

public void setEdgeGroup(DialerCampaignConfigChangeUriReference edgeGroup)

site

public DialerCampaignConfigChangeCampaign site(DialerCampaignConfigChangeUriReference site)

A UriReference for a resource

getSite

public DialerCampaignConfigChangeUriReference getSite()

setSite

public void setSite(DialerCampaignConfigChangeUriReference site)

campaignStatus

public DialerCampaignConfigChangeCampaign campaignStatus(DialerCampaignConfigChangeCampaign.CampaignStatusEnum campaignStatus)

getCampaignStatus

public DialerCampaignConfigChangeCampaign.CampaignStatusEnum getCampaignStatus()

setCampaignStatus

public void setCampaignStatus(DialerCampaignConfigChangeCampaign.CampaignStatusEnum campaignStatus)

phoneColumns

public DialerCampaignConfigChangeCampaign phoneColumns(List<DialerCampaignConfigChangePhoneColumn> phoneColumns)

the contact list phone columns to be called for the campaign

getPhoneColumns

public List<DialerCampaignConfigChangePhoneColumn> getPhoneColumns()

setPhoneColumns

public void setPhoneColumns(List<DialerCampaignConfigChangePhoneColumn> phoneColumns)

abandonRate

public DialerCampaignConfigChangeCampaign abandonRate(BigDecimal abandonRate)

the targeted abandon rate percentage

getAbandonRate

public BigDecimal getAbandonRate()

setAbandonRate

public void setAbandonRate(BigDecimal abandonRate)

dncLists

public DialerCampaignConfigChangeCampaign dncLists(List<DialerCampaignConfigChangeUriReference> dncLists)

identifiers of the do not call lists

getDncLists

public List<DialerCampaignConfigChangeUriReference> getDncLists()

setDncLists

public void setDncLists(List<DialerCampaignConfigChangeUriReference> dncLists)

callableTimeSet

public DialerCampaignConfigChangeCampaign callableTimeSet(DialerCampaignConfigChangeUriReference callableTimeSet)

A UriReference for a resource

getCallableTimeSet

public DialerCampaignConfigChangeUriReference getCallableTimeSet()

setCallableTimeSet

public void setCallableTimeSet(DialerCampaignConfigChangeUriReference callableTimeSet)

callAnalysisResponseSet

public DialerCampaignConfigChangeCampaign callAnalysisResponseSet(DialerCampaignConfigChangeUriReference callAnalysisResponseSet)

A UriReference for a resource

getCallAnalysisResponseSet

public DialerCampaignConfigChangeUriReference getCallAnalysisResponseSet()

setCallAnalysisResponseSet

public void setCallAnalysisResponseSet(DialerCampaignConfigChangeUriReference callAnalysisResponseSet)

callerName

public DialerCampaignConfigChangeCampaign callerName(String callerName)

caller id name to be displayed on the outbound call

getCallerName

public String getCallerName()

setCallerName

public void setCallerName(String callerName)

callerAddress

public DialerCampaignConfigChangeCampaign callerAddress(String callerAddress)

caller id phone number to be displayed on the outbound call

getCallerAddress

public String getCallerAddress()

setCallerAddress

public void setCallerAddress(String callerAddress)

outboundLineCount

public DialerCampaignConfigChangeCampaign outboundLineCount(Long outboundLineCount)

for agentless campaigns, the number of outbound lines to be concurrently dialed

getOutboundLineCount

public Long getOutboundLineCount()

setOutboundLineCount

public void setOutboundLineCount(Long outboundLineCount)

errors

public DialerCampaignConfigChangeCampaign errors(List<DialerCampaignConfigChangeRestErrorDetail> errors)

a list of current error conditions associated with the campaign

getErrors

public List<DialerCampaignConfigChangeRestErrorDetail> getErrors()

setErrors

public void setErrors(List<DialerCampaignConfigChangeRestErrorDetail> errors)

ruleSets

public DialerCampaignConfigChangeCampaign ruleSets(List<DialerCampaignConfigChangeUriReference> ruleSets)

identifiers of the rule sets

getRuleSets

public List<DialerCampaignConfigChangeUriReference> getRuleSets()

setRuleSets

public void setRuleSets(List<DialerCampaignConfigChangeUriReference> ruleSets)

skipPreviewDisabled

public DialerCampaignConfigChangeCampaign skipPreviewDisabled(Boolean skipPreviewDisabled)

for preview campaigns, indicator of whether the agent can skip a preview without placing a call

getSkipPreviewDisabled

public Boolean getSkipPreviewDisabled()

setSkipPreviewDisabled

public void setSkipPreviewDisabled(Boolean skipPreviewDisabled)

previewTimeOutSeconds

public DialerCampaignConfigChangeCampaign previewTimeOutSeconds(Long previewTimeOutSeconds)

for preview campaigns, number of seconds before a call will be automatically placed. A value of 0 indicates no automatic placement of calls

getPreviewTimeOutSeconds

public Long getPreviewTimeOutSeconds()

setPreviewTimeOutSeconds

public void setPreviewTimeOutSeconds(Long previewTimeOutSeconds)

singleNumberPreview

public DialerCampaignConfigChangeCampaign singleNumberPreview(Boolean singleNumberPreview)

for preview campaigns with multiple phone columns, indicator if one (true) or multiple (false) phone numbers will be available to call for each preview

getSingleNumberPreview

public Boolean getSingleNumberPreview()

setSingleNumberPreview

public void setSingleNumberPreview(Boolean singleNumberPreview)

contactSort

public DialerCampaignConfigChangeCampaign contactSort(DialerCampaignConfigChangeContactSort contactSort)

getContactSort

public DialerCampaignConfigChangeContactSort getContactSort()

setContactSort

public void setContactSort(DialerCampaignConfigChangeContactSort contactSort)

contactSorts

public DialerCampaignConfigChangeCampaign contactSorts(List<DialerCampaignConfigChangeContactSort> contactSorts)

List of contact sort objects.

getContactSorts

public List<DialerCampaignConfigChangeContactSort> getContactSorts()

setContactSorts

public void setContactSorts(List<DialerCampaignConfigChangeContactSort> contactSorts)

noAnswerTimeout

public DialerCampaignConfigChangeCampaign noAnswerTimeout(Long noAnswerTimeout)

for non-preview campaigns, how long to wait before dispositioning as 'no-answer', default 30 seconds

getNoAnswerTimeout

public Long getNoAnswerTimeout()

setNoAnswerTimeout

public void setNoAnswerTimeout(Long noAnswerTimeout)

callAnalysisLanguage

public DialerCampaignConfigChangeCampaign 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 DialerCampaignConfigChangeCampaign priority(Long priority)

The priority of this campaign relative to other campaigns

getPriority

public Long getPriority()

setPriority

public void setPriority(Long priority)

contactListFilters

public DialerCampaignConfigChangeCampaign contactListFilters(List<DialerCampaignConfigChangeUriReference> contactListFilters)

List of contact filters

getContactListFilters

public List<DialerCampaignConfigChangeUriReference> getContactListFilters()

setContactListFilters

public void setContactListFilters(List<DialerCampaignConfigChangeUriReference> contactListFilters)

division

public DialerCampaignConfigChangeCampaign division(DialerCampaignConfigChangeUriReference division)

A UriReference for a resource

getDivision

public DialerCampaignConfigChangeUriReference getDivision()

setDivision

public void setDivision(DialerCampaignConfigChangeUriReference division)

agentOwnedColumn

public DialerCampaignConfigChangeCampaign agentOwnedColumn(String agentOwnedColumn)

For Preview Campaigns. Name of the contact column in the contact list containing the userIds of agents to assign specific contact records to.

getAgentOwnedColumn

public String getAgentOwnedColumn()

setAgentOwnedColumn

public void setAgentOwnedColumn(String agentOwnedColumn)

additionalProperties

public DialerCampaignConfigChangeCampaign additionalProperties(Map<String,Object> additionalProperties)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)

id

public DialerCampaignConfigChangeCampaign id(String id)

The globally unique identifier for the object.

getId

public String getId()

setId

public void setId(String id)

name

public DialerCampaignConfigChangeCampaign name(String name)

The UI-visible name of the object

getName

public String getName()

setName

public void setName(String name)

dateCreated

public DialerCampaignConfigChangeCampaign dateCreated(Date dateCreated)

Creation time of the entity

getDateCreated

public Date getDateCreated()

setDateCreated

public void setDateCreated(Date dateCreated)

dateModified

public DialerCampaignConfigChangeCampaign dateModified(Date dateModified)

Last modified time of the entity

getDateModified

public Date getDateModified()

setDateModified

public void setDateModified(Date dateModified)

version

public DialerCampaignConfigChangeCampaign version(Long version)

Required for updates, must match the version number of the most recent update

getVersion

public Long getVersion()

setVersion

public void setVersion(Long version)

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