Package com.mypurecloud.sdk.v2.model

Class QueueConversationSocialExpressionEventTopicCallback

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicCallback

All Implemented Interfaces:

Serializable

public class QueueConversationSocialExpressionEventTopicCallback
extends Object
implements Serializable

QueueConversationSocialExpressionEventTopicCallback

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueueConversationSocialExpressionEventTopicCallback.DirectionEnum	The direction of the call
static enum	QueueConversationSocialExpressionEventTopicCallback.DisconnectTypeEnum	System defined string indicating what caused the communication to disconnect.
static enum	QueueConversationSocialExpressionEventTopicCallback.InitialStateEnum	Gets or Sets initialState
static enum	QueueConversationSocialExpressionEventTopicCallback.StateEnum	Gets or Sets state

Constructor Summary

Constructors

Constructor	Description
QueueConversationSocialExpressionEventTopicCallback()
QueueConversationSocialExpressionEventTopicCallback(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
QueueConversationSocialExpressionEventTopicCallback	afterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)	A communication's after-call work data.
QueueConversationSocialExpressionEventTopicCallback	afterCallWorkRequired(Boolean afterCallWorkRequired)	Indicates if after-call is required for a communication.
QueueConversationSocialExpressionEventTopicCallback	automatedCallbackConfigId(String automatedCallbackConfigId)	The id of the config for automatically placing the callback (and handling the disposition).
QueueConversationSocialExpressionEventTopicCallback	callbackNumbers(List<String> callbackNumbers)	The phone number(s) to use to place the callback.
QueueConversationSocialExpressionEventTopicCallback	callbackScheduledTime(Date callbackScheduledTime)	The timestamp when this communication is scheduled in the provider clock.
QueueConversationSocialExpressionEventTopicCallback	callbackUserName(String callbackUserName)	The name of the user requesting a callback.
QueueConversationSocialExpressionEventTopicCallback	callerId(String callerId)	The phone number displayed to recipients of the phone call.
QueueConversationSocialExpressionEventTopicCallback	callerIdName(String callerIdName)	The name displayed to recipients of the phone call.
QueueConversationSocialExpressionEventTopicCallback	connectedTime(Date connectedTime)	The timestamp when this communication was connected in the cloud clock.
QueueConversationSocialExpressionEventTopicCallback	dialerPreview(QueueConversationSocialExpressionEventTopicDialerPreview dialerPreview)
QueueConversationSocialExpressionEventTopicCallback	direction(QueueConversationSocialExpressionEventTopicCallback.DirectionEnum direction)	The direction of the call
QueueConversationSocialExpressionEventTopicCallback	disconnectedTime(Date disconnectedTime)	The timestamp when this communication disconnected from the conversation in the provider clock.
QueueConversationSocialExpressionEventTopicCallback	disconnectType(QueueConversationSocialExpressionEventTopicCallback.DisconnectTypeEnum disconnectType)	System defined string indicating what caused the communication to disconnect.
boolean	equals(Object o)
QueueConversationSocialExpressionEventTopicCallback	externalCampaign(Boolean externalCampaign)	True if the call for the callback uses external dialing.
QueueConversationSocialExpressionEventTopicAfterCallWork	getAfterCallWork()
Boolean	getAfterCallWorkRequired()
String	getAutomatedCallbackConfigId()
List<String>	getCallbackNumbers()
Date	getCallbackScheduledTime()
String	getCallbackUserName()
String	getCallerId()
String	getCallerIdName()
Date	getConnectedTime()
QueueConversationSocialExpressionEventTopicDialerPreview	getDialerPreview()
QueueConversationSocialExpressionEventTopicCallback.DirectionEnum	getDirection()
Date	getDisconnectedTime()
QueueConversationSocialExpressionEventTopicCallback.DisconnectTypeEnum	getDisconnectType()
Boolean	getExternalCampaign()
Boolean	getHeld()
String	getId()
QueueConversationSocialExpressionEventTopicCallback.InitialStateEnum	getInitialState()
String	getPeerId()
String	getProvider()
QueueConversationSocialExpressionEventTopicQueueMediaSettings	getQueueMediaSettings()
String	getScriptId()
Boolean	getSkipEnabled()
Date	getStartHoldTime()
QueueConversationSocialExpressionEventTopicCallback.StateEnum	getState()
Long	getTimeoutSeconds()
QueueConversationSocialExpressionEventTopicVoicemail	getVoicemail()
QueueConversationSocialExpressionEventTopicWrapup	getWrapup()
int	hashCode()
QueueConversationSocialExpressionEventTopicCallback	held(Boolean held)	True if this call is held and the person on this side hears silence.
QueueConversationSocialExpressionEventTopicCallback	id(String id)	A globally unique identifier for this communication.
QueueConversationSocialExpressionEventTopicCallback	initialState(QueueConversationSocialExpressionEventTopicCallback.InitialStateEnum initialState)
QueueConversationSocialExpressionEventTopicCallback	peerId(String peerId)	The id of the peer communication corresponding to a matching leg for this communication.
QueueConversationSocialExpressionEventTopicCallback	provider(String provider)	The source provider of the callback.
QueueConversationSocialExpressionEventTopicCallback	queueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)	Represents the queue setting for this media.
QueueConversationSocialExpressionEventTopicCallback	scriptId(String scriptId)	The UUID of the script to use.
void	setAfterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)
void	setAfterCallWorkRequired(Boolean afterCallWorkRequired)
void	setAutomatedCallbackConfigId(String automatedCallbackConfigId)
void	setCallbackNumbers(List<String> callbackNumbers)
void	setCallbackScheduledTime(Date callbackScheduledTime)
void	setCallbackUserName(String callbackUserName)
void	setCallerId(String callerId)
void	setCallerIdName(String callerIdName)
void	setConnectedTime(Date connectedTime)
void	setDialerPreview(QueueConversationSocialExpressionEventTopicDialerPreview dialerPreview)
void	setDirection(QueueConversationSocialExpressionEventTopicCallback.DirectionEnum direction)
void	setDisconnectedTime(Date disconnectedTime)
void	setDisconnectType(QueueConversationSocialExpressionEventTopicCallback.DisconnectTypeEnum disconnectType)
void	setExternalCampaign(Boolean externalCampaign)
void	setHeld(Boolean held)
void	setId(String id)
void	setInitialState(QueueConversationSocialExpressionEventTopicCallback.InitialStateEnum initialState)
void	setPeerId(String peerId)
void	setProvider(String provider)
void	setQueueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)
void	setScriptId(String scriptId)
void	setSkipEnabled(Boolean skipEnabled)
void	setStartHoldTime(Date startHoldTime)
void	setState(QueueConversationSocialExpressionEventTopicCallback.StateEnum state)
void	setTimeoutSeconds(Long timeoutSeconds)
void	setVoicemail(QueueConversationSocialExpressionEventTopicVoicemail voicemail)
void	setWrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)
QueueConversationSocialExpressionEventTopicCallback	skipEnabled(Boolean skipEnabled)	True if the ability to skip a callback should be enabled.
QueueConversationSocialExpressionEventTopicCallback	startHoldTime(Date startHoldTime)	The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold.
QueueConversationSocialExpressionEventTopicCallback	state(QueueConversationSocialExpressionEventTopicCallback.StateEnum state)
QueueConversationSocialExpressionEventTopicCallback	timeoutSeconds(Long timeoutSeconds)	The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled.
String	toString()
QueueConversationSocialExpressionEventTopicCallback	voicemail(QueueConversationSocialExpressionEventTopicVoicemail voicemail)
QueueConversationSocialExpressionEventTopicCallback	wrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)	Call wrap up or disposition data.

Methods inherited from class java.lang.Object

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

Constructor Details

QueueConversationSocialExpressionEventTopicCallback

public QueueConversationSocialExpressionEventTopicCallback()

QueueConversationSocialExpressionEventTopicCallback

public QueueConversationSocialExpressionEventTopicCallback(Boolean initWithEmptyList)

Method Details

state

public QueueConversationSocialExpressionEventTopicCallback state(QueueConversationSocialExpressionEventTopicCallback.StateEnum state)

getState

public QueueConversationSocialExpressionEventTopicCallback.StateEnum getState()

setState

public void setState(QueueConversationSocialExpressionEventTopicCallback.StateEnum state)

initialState

public QueueConversationSocialExpressionEventTopicCallback initialState(QueueConversationSocialExpressionEventTopicCallback.InitialStateEnum initialState)

getInitialState

public QueueConversationSocialExpressionEventTopicCallback.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationSocialExpressionEventTopicCallback.InitialStateEnum initialState)

id

public QueueConversationSocialExpressionEventTopicCallback id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

direction

public QueueConversationSocialExpressionEventTopicCallback direction(QueueConversationSocialExpressionEventTopicCallback.DirectionEnum direction)

The direction of the call

getDirection

public QueueConversationSocialExpressionEventTopicCallback.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationSocialExpressionEventTopicCallback.DirectionEnum direction)

held

public QueueConversationSocialExpressionEventTopicCallback held(Boolean held)

True if this call is held and the person on this side hears silence.

getHeld

public Boolean getHeld()

setHeld

public void setHeld(Boolean held)

disconnectType

public QueueConversationSocialExpressionEventTopicCallback disconnectType(QueueConversationSocialExpressionEventTopicCallback.DisconnectTypeEnum disconnectType)

System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.

getDisconnectType

public QueueConversationSocialExpressionEventTopicCallback.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationSocialExpressionEventTopicCallback.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationSocialExpressionEventTopicCallback startHoldTime(Date startHoldTime)

The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold.

getStartHoldTime

public Date getStartHoldTime()

setStartHoldTime

public void setStartHoldTime(Date startHoldTime)

dialerPreview

public QueueConversationSocialExpressionEventTopicCallback dialerPreview(QueueConversationSocialExpressionEventTopicDialerPreview dialerPreview)

getDialerPreview

public QueueConversationSocialExpressionEventTopicDialerPreview getDialerPreview()

setDialerPreview

public void setDialerPreview(QueueConversationSocialExpressionEventTopicDialerPreview dialerPreview)

voicemail

public QueueConversationSocialExpressionEventTopicCallback voicemail(QueueConversationSocialExpressionEventTopicVoicemail voicemail)

getVoicemail

public QueueConversationSocialExpressionEventTopicVoicemail getVoicemail()

setVoicemail

public void setVoicemail(QueueConversationSocialExpressionEventTopicVoicemail voicemail)

callbackNumbers

public QueueConversationSocialExpressionEventTopicCallback callbackNumbers(List<String> callbackNumbers)

The phone number(s) to use to place the callback.

getCallbackNumbers

public List<String> getCallbackNumbers()

setCallbackNumbers

public void setCallbackNumbers(List<String> callbackNumbers)

callbackUserName

public QueueConversationSocialExpressionEventTopicCallback callbackUserName(String callbackUserName)

The name of the user requesting a callback.

getCallbackUserName

public String getCallbackUserName()

setCallbackUserName

public void setCallbackUserName(String callbackUserName)

scriptId

public QueueConversationSocialExpressionEventTopicCallback scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

public QueueConversationSocialExpressionEventTopicCallback peerId(String peerId)

The id of the peer communication corresponding to a matching leg for this communication.

getPeerId

public String getPeerId()

setPeerId

public void setPeerId(String peerId)

externalCampaign

public QueueConversationSocialExpressionEventTopicCallback externalCampaign(Boolean externalCampaign)

True if the call for the callback uses external dialing.

getExternalCampaign

public Boolean getExternalCampaign()

setExternalCampaign

public void setExternalCampaign(Boolean externalCampaign)

skipEnabled

public QueueConversationSocialExpressionEventTopicCallback skipEnabled(Boolean skipEnabled)

True if the ability to skip a callback should be enabled.

getSkipEnabled

public Boolean getSkipEnabled()

setSkipEnabled

public void setSkipEnabled(Boolean skipEnabled)

provider

public QueueConversationSocialExpressionEventTopicCallback provider(String provider)

The source provider of the callback.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

timeoutSeconds

public QueueConversationSocialExpressionEventTopicCallback timeoutSeconds(Long timeoutSeconds)

The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled.

getTimeoutSeconds

public Long getTimeoutSeconds()

setTimeoutSeconds

public void setTimeoutSeconds(Long timeoutSeconds)

connectedTime

public QueueConversationSocialExpressionEventTopicCallback connectedTime(Date connectedTime)

The timestamp when this communication was connected in the cloud clock.

getConnectedTime

public Date getConnectedTime()

setConnectedTime

public void setConnectedTime(Date connectedTime)

disconnectedTime

public QueueConversationSocialExpressionEventTopicCallback disconnectedTime(Date disconnectedTime)

The timestamp when this communication disconnected from the conversation in the provider clock.

getDisconnectedTime

public Date getDisconnectedTime()

setDisconnectedTime

public void setDisconnectedTime(Date disconnectedTime)

callbackScheduledTime

public QueueConversationSocialExpressionEventTopicCallback callbackScheduledTime(Date callbackScheduledTime)

The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately.

getCallbackScheduledTime

public Date getCallbackScheduledTime()

setCallbackScheduledTime

public void setCallbackScheduledTime(Date callbackScheduledTime)

automatedCallbackConfigId

public QueueConversationSocialExpressionEventTopicCallback automatedCallbackConfigId(String automatedCallbackConfigId)

The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal.

getAutomatedCallbackConfigId

public String getAutomatedCallbackConfigId()

setAutomatedCallbackConfigId

public void setAutomatedCallbackConfigId(String automatedCallbackConfigId)

wrapup

public QueueConversationSocialExpressionEventTopicCallback wrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationSocialExpressionEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)

afterCallWork

public QueueConversationSocialExpressionEventTopicCallback afterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public QueueConversationSocialExpressionEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public QueueConversationSocialExpressionEventTopicCallback afterCallWorkRequired(Boolean afterCallWorkRequired)

Indicates if after-call is required for a communication. Only used when the ACW Setting is Agent Requested.

getAfterCallWorkRequired

public Boolean getAfterCallWorkRequired()

setAfterCallWorkRequired

public void setAfterCallWorkRequired(Boolean afterCallWorkRequired)

callerId

public QueueConversationSocialExpressionEventTopicCallback callerId(String callerId)

The phone number displayed to recipients of the phone call. The value should conform to the E164 format.

getCallerId

public String getCallerId()

setCallerId

public void setCallerId(String callerId)

callerIdName

public QueueConversationSocialExpressionEventTopicCallback callerIdName(String callerIdName)

The name displayed to recipients of the phone call.

getCallerIdName

public String getCallerIdName()

setCallerIdName

public void setCallerIdName(String callerIdName)

queueMediaSettings

public QueueConversationSocialExpressionEventTopicCallback queueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public QueueConversationSocialExpressionEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)

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