Package com.mypurecloud.sdk.v2.model

Class QueueConversationEventTopicCallback

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationEventTopicCallback

All Implemented Interfaces:

Serializable

public class QueueConversationEventTopicCallback
extends Object
implements Serializable

QueueConversationEventTopicCallback

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
QueueConversationEventTopicCallback()
QueueConversationEventTopicCallback(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

QueueConversationEventTopicCallback

public QueueConversationEventTopicCallback()

QueueConversationEventTopicCallback

public QueueConversationEventTopicCallback(Boolean initWithEmptyList)

Method Details

state

public QueueConversationEventTopicCallback state(QueueConversationEventTopicCallback.StateEnum state)

getState

public QueueConversationEventTopicCallback.StateEnum getState()

setState

public void setState(QueueConversationEventTopicCallback.StateEnum state)

initialState

public QueueConversationEventTopicCallback initialState(QueueConversationEventTopicCallback.InitialStateEnum initialState)

getInitialState

public QueueConversationEventTopicCallback.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationEventTopicCallback.InitialStateEnum initialState)

id

public QueueConversationEventTopicCallback id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

direction

public QueueConversationEventTopicCallback direction(QueueConversationEventTopicCallback.DirectionEnum direction)

The direction of the call

getDirection

public QueueConversationEventTopicCallback.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationEventTopicCallback.DirectionEnum direction)

held

public QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback disconnectType(QueueConversationEventTopicCallback.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public QueueConversationEventTopicCallback.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationEventTopicCallback.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback dialerPreview(QueueConversationEventTopicDialerPreview dialerPreview)

getDialerPreview

public QueueConversationEventTopicDialerPreview getDialerPreview()

setDialerPreview

public void setDialerPreview(QueueConversationEventTopicDialerPreview dialerPreview)

voicemail

public QueueConversationEventTopicCallback voicemail(QueueConversationEventTopicVoicemail voicemail)

getVoicemail

public QueueConversationEventTopicVoicemail getVoicemail()

setVoicemail

public void setVoicemail(QueueConversationEventTopicVoicemail voicemail)

callbackNumbers

public QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback callbackUserName(String callbackUserName)

The name of the user requesting a callback.

getCallbackUserName

public String getCallbackUserName()

setCallbackUserName

public void setCallbackUserName(String callbackUserName)

scriptId

public QueueConversationEventTopicCallback scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

public QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback provider(String provider)

The source provider of the callback.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

timeoutSeconds

public QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback wrapup(QueueConversationEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationEventTopicWrapup wrapup)

afterCallWork

public QueueConversationEventTopicCallback afterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public QueueConversationEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback 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 QueueConversationEventTopicCallback callerIdName(String callerIdName)

The name displayed to recipients of the phone call.

getCallerIdName

public String getCallerIdName()

setCallerIdName

public void setCallerIdName(String callerIdName)

queueMediaSettings

public QueueConversationEventTopicCallback queueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public QueueConversationEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationEventTopicQueueMediaSettings 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