Package com.mypurecloud.sdk.v2.model

Class QueueConversationVideoEventTopicCallback

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicCallback

All Implemented Interfaces:

Serializable

public class QueueConversationVideoEventTopicCallback
extends Object
implements Serializable

QueueConversationVideoEventTopicCallback

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
QueueConversationVideoEventTopicCallback()
QueueConversationVideoEventTopicCallback(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

QueueConversationVideoEventTopicCallback

public QueueConversationVideoEventTopicCallback()

QueueConversationVideoEventTopicCallback

public QueueConversationVideoEventTopicCallback(Boolean initWithEmptyList)

Method Details

state

public QueueConversationVideoEventTopicCallback state(QueueConversationVideoEventTopicCallback.StateEnum state)

getState

public QueueConversationVideoEventTopicCallback.StateEnum getState()

setState

public void setState(QueueConversationVideoEventTopicCallback.StateEnum state)

initialState

public QueueConversationVideoEventTopicCallback initialState(QueueConversationVideoEventTopicCallback.InitialStateEnum initialState)

getInitialState

public QueueConversationVideoEventTopicCallback.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationVideoEventTopicCallback.InitialStateEnum initialState)

id

public QueueConversationVideoEventTopicCallback id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

direction

public QueueConversationVideoEventTopicCallback direction(QueueConversationVideoEventTopicCallback.DirectionEnum direction)

The direction of the call

getDirection

public QueueConversationVideoEventTopicCallback.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationVideoEventTopicCallback.DirectionEnum direction)

held

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

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

getDisconnectType

public QueueConversationVideoEventTopicCallback.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationVideoEventTopicCallback.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationVideoEventTopicCallback 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 QueueConversationVideoEventTopicCallback dialerPreview(QueueConversationVideoEventTopicDialerPreview dialerPreview)

getDialerPreview

public QueueConversationVideoEventTopicDialerPreview getDialerPreview()

setDialerPreview

public void setDialerPreview(QueueConversationVideoEventTopicDialerPreview dialerPreview)

voicemail

public QueueConversationVideoEventTopicCallback voicemail(QueueConversationVideoEventTopicVoicemail voicemail)

getVoicemail

public QueueConversationVideoEventTopicVoicemail getVoicemail()

setVoicemail

public void setVoicemail(QueueConversationVideoEventTopicVoicemail voicemail)

callbackNumbers

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

The name of the user requesting a callback.

getCallbackUserName

public String getCallbackUserName()

setCallbackUserName

public void setCallbackUserName(String callbackUserName)

scriptId

public QueueConversationVideoEventTopicCallback scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

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

The source provider of the callback.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

timeoutSeconds

public QueueConversationVideoEventTopicCallback 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 QueueConversationVideoEventTopicCallback 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 QueueConversationVideoEventTopicCallback 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 QueueConversationVideoEventTopicCallback 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 QueueConversationVideoEventTopicCallback 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 QueueConversationVideoEventTopicCallback wrapup(QueueConversationVideoEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationVideoEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationVideoEventTopicWrapup wrapup)

afterCallWork

public QueueConversationVideoEventTopicCallback afterCallWork(QueueConversationVideoEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public QueueConversationVideoEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationVideoEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

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

The name displayed to recipients of the phone call.

getCallerIdName

public String getCallerIdName()

setCallerIdName

public void setCallerIdName(String callerIdName)

queueMediaSettings

public QueueConversationVideoEventTopicCallback queueMediaSettings(QueueConversationVideoEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public QueueConversationVideoEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

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