Package com.mypurecloud.sdk.v2.model

Class MessagingCampaign

java.lang.Object

com.mypurecloud.sdk.v2.model.MessagingCampaign

All Implemented Interfaces:

Serializable

public class MessagingCampaign
extends Object
implements Serializable

MessagingCampaign

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MessagingCampaign.CampaignStatusEnum	The current status of the messaging campaign.

Constructor Summary

Constructors

Constructor	Description
MessagingCampaign()
MessagingCampaign(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
MessagingCampaign	alwaysRunning(Boolean alwaysRunning)	Whether this messaging campaign is always running
MessagingCampaign	callableTimeSet(DomainEntityRef callableTimeSet)	The callable time set for this messaging campaign.
MessagingCampaign	campaignStatus(MessagingCampaign.CampaignStatusEnum campaignStatus)	The current status of the messaging campaign.
MessagingCampaign	contactList(DomainEntityRef contactList)	The contact list that this messaging campaign will send messages for.
MessagingCampaign	contactListFilters(List<DomainEntityRef> contactListFilters)	The contact list filter to check before sending a message for this messaging campaign.
MessagingCampaign	contactSorts(List<ContactSort> contactSorts)	The order in which to sort contacts for dialing, based on up to four columns.
MessagingCampaign	division(DomainEntityRef division)	The division this entity belongs to.
MessagingCampaign	dncLists(List<DomainEntityRef> dncLists)	The dnc lists to check before sending a message for this messaging campaign.
MessagingCampaign	dynamicContactQueueingSettings(DynamicContactQueueingSettings dynamicContactQueueingSettings)	Indicates (when true) that the campaign supports dynamic queueing of the contact list at the time of a request for contacts.
MessagingCampaign	emailConfig(EmailConfig emailConfig)	Configuration for this messaging campaign to send Email messages.
boolean	equals(Object o)
MessagingCampaign	errors(List<RestErrorDetail> errors)	A list of current error conditions associated with this messaging campaign.
Boolean	getAlwaysRunning()
DomainEntityRef	getCallableTimeSet()
MessagingCampaign.CampaignStatusEnum	getCampaignStatus()
DomainEntityRef	getContactList()
List<DomainEntityRef>	getContactListFilters()
List<ContactSort>	getContactSorts()
Date	getDateCreated()
Date	getDateModified()
DomainEntityRef	getDivision()
List<DomainEntityRef>	getDncLists()
DynamicContactQueueingSettings	getDynamicContactQueueingSettings()
EmailConfig	getEmailConfig()
List<RestErrorDetail>	getErrors()
String	getId()
Integer	getMessagesPerMinute()
String	getName()
List<DomainEntityRef>	getRuleSets()
String	getSelfUri()
SmsConfig	getSmsConfig()
Integer	getVersion()
WhatsAppConfig	getWhatsAppConfig()
int	hashCode()
MessagingCampaign	messagesPerMinute(Integer messagesPerMinute)	How many messages this messaging campaign will send per minute.
MessagingCampaign	name(String name)
MessagingCampaign	ruleSets(List<DomainEntityRef> ruleSets)	Rule Sets to be applied while this campaign is sending messages
void	setAlwaysRunning(Boolean alwaysRunning)
void	setCallableTimeSet(DomainEntityRef callableTimeSet)
void	setCampaignStatus(MessagingCampaign.CampaignStatusEnum campaignStatus)
void	setContactList(DomainEntityRef contactList)
void	setContactListFilters(List<DomainEntityRef> contactListFilters)
void	setContactSorts(List<ContactSort> contactSorts)
void	setDivision(DomainEntityRef division)
void	setDncLists(List<DomainEntityRef> dncLists)
void	setDynamicContactQueueingSettings(DynamicContactQueueingSettings dynamicContactQueueingSettings)
void	setEmailConfig(EmailConfig emailConfig)
void	setErrors(List<RestErrorDetail> errors)
void	setMessagesPerMinute(Integer messagesPerMinute)
void	setName(String name)
void	setRuleSets(List<DomainEntityRef> ruleSets)
void	setSmsConfig(SmsConfig smsConfig)
void	setVersion(Integer version)
void	setWhatsAppConfig(WhatsAppConfig whatsAppConfig)
MessagingCampaign	smsConfig(SmsConfig smsConfig)	Configuration for this messaging campaign to send SMS messages.
String	toString()
MessagingCampaign	version(Integer version)	Required for updates, must match the version number of the most recent update
MessagingCampaign	whatsAppConfig(WhatsAppConfig whatsAppConfig)	Configuration for this messaging campaign to send WhatsApp messages.

Methods inherited from class java.lang.Object

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

Constructor Details

MessagingCampaign

public MessagingCampaign()

MessagingCampaign

public MessagingCampaign(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public MessagingCampaign name(String name)

getName

public String getName()

setName

public void setName(String name)

getDateCreated

public Date getDateCreated()

getDateModified

public Date getDateModified()

version

public MessagingCampaign 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)

division

public MessagingCampaign division(DomainEntityRef division)

The division this entity belongs to.

getDivision

public DomainEntityRef getDivision()

setDivision

public void setDivision(DomainEntityRef division)

campaignStatus

public MessagingCampaign campaignStatus(MessagingCampaign.CampaignStatusEnum campaignStatus)

The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'.

getCampaignStatus

public MessagingCampaign.CampaignStatusEnum getCampaignStatus()

setCampaignStatus

public void setCampaignStatus(MessagingCampaign.CampaignStatusEnum campaignStatus)

callableTimeSet

public MessagingCampaign callableTimeSet(DomainEntityRef callableTimeSet)

The callable time set for this messaging campaign.

getCallableTimeSet

public DomainEntityRef getCallableTimeSet()

setCallableTimeSet

public void setCallableTimeSet(DomainEntityRef callableTimeSet)

contactList

public MessagingCampaign contactList(DomainEntityRef contactList)

The contact list that this messaging campaign will send messages for.

getContactList

public DomainEntityRef getContactList()

setContactList

public void setContactList(DomainEntityRef contactList)

dncLists

public MessagingCampaign dncLists(List<DomainEntityRef> dncLists)

The dnc lists to check before sending a message for this messaging campaign.

getDncLists

public List<DomainEntityRef> getDncLists()

setDncLists

public void setDncLists(List<DomainEntityRef> dncLists)

alwaysRunning

public MessagingCampaign alwaysRunning(Boolean alwaysRunning)

Whether this messaging campaign is always running

getAlwaysRunning

public Boolean getAlwaysRunning()

setAlwaysRunning

public void setAlwaysRunning(Boolean alwaysRunning)

contactSorts

public MessagingCampaign 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)

messagesPerMinute

public MessagingCampaign messagesPerMinute(Integer messagesPerMinute)

How many messages this messaging campaign will send per minute.

getMessagesPerMinute

public Integer getMessagesPerMinute()

setMessagesPerMinute

public void setMessagesPerMinute(Integer messagesPerMinute)

ruleSets

public MessagingCampaign ruleSets(List<DomainEntityRef> ruleSets)

Rule Sets to be applied while this campaign is sending messages

getRuleSets

public List<DomainEntityRef> getRuleSets()

setRuleSets

public void setRuleSets(List<DomainEntityRef> ruleSets)

contactListFilters

public MessagingCampaign contactListFilters(List<DomainEntityRef> contactListFilters)

The contact list filter to check before sending a message for this messaging campaign.

getContactListFilters

public List<DomainEntityRef> getContactListFilters()

setContactListFilters

public void setContactListFilters(List<DomainEntityRef> contactListFilters)

errors

public MessagingCampaign errors(List<RestErrorDetail> errors)

A list of current error conditions associated with this messaging campaign.

getErrors

public List<RestErrorDetail> getErrors()

setErrors

public void setErrors(List<RestErrorDetail> errors)

dynamicContactQueueingSettings

public MessagingCampaign dynamicContactQueueingSettings(DynamicContactQueueingSettings dynamicContactQueueingSettings)

Indicates (when true) that the campaign supports dynamic queueing of the contact list at the time of a request for contacts.

getDynamicContactQueueingSettings

public DynamicContactQueueingSettings getDynamicContactQueueingSettings()

setDynamicContactQueueingSettings

public void setDynamicContactQueueingSettings(DynamicContactQueueingSettings dynamicContactQueueingSettings)

emailConfig

public MessagingCampaign emailConfig(EmailConfig emailConfig)

Configuration for this messaging campaign to send Email messages.

getEmailConfig

public EmailConfig getEmailConfig()

setEmailConfig

public void setEmailConfig(EmailConfig emailConfig)

smsConfig

public MessagingCampaign smsConfig(SmsConfig smsConfig)

Configuration for this messaging campaign to send SMS messages.

getSmsConfig

public SmsConfig getSmsConfig()

setSmsConfig

public void setSmsConfig(SmsConfig smsConfig)

whatsAppConfig

public MessagingCampaign whatsAppConfig(WhatsAppConfig whatsAppConfig)

Configuration for this messaging campaign to send WhatsApp messages.

getWhatsAppConfig

public WhatsAppConfig getWhatsAppConfig()

setWhatsAppConfig

public void setWhatsAppConfig(WhatsAppConfig whatsAppConfig)

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