Package com.mypurecloud.sdk.v2.model

Class ConversationEventTopicCallback

java.lang.Object

com.mypurecloud.sdk.v2.model.ConversationEventTopicCallback

All Implemented Interfaces:

Serializable

public class ConversationEventTopicCallback
extends Object
implements Serializable

ConversationEventTopicCallback

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ConversationEventTopicCallback()
ConversationEventTopicCallback(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ConversationEventTopicCallback

public ConversationEventTopicCallback()

ConversationEventTopicCallback

public ConversationEventTopicCallback(Boolean initWithEmptyList)

Method Details

state

public ConversationEventTopicCallback state(ConversationEventTopicCallback.StateEnum state)

getState

public ConversationEventTopicCallback.StateEnum getState()

setState

public void setState(ConversationEventTopicCallback.StateEnum state)

initialState

public ConversationEventTopicCallback initialState(ConversationEventTopicCallback.InitialStateEnum initialState)

getInitialState

public ConversationEventTopicCallback.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(ConversationEventTopicCallback.InitialStateEnum initialState)

id

public ConversationEventTopicCallback id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

direction

public ConversationEventTopicCallback direction(ConversationEventTopicCallback.DirectionEnum direction)

The direction of the call

getDirection

public ConversationEventTopicCallback.DirectionEnum getDirection()

setDirection

public void setDirection(ConversationEventTopicCallback.DirectionEnum direction)

held

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

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

getDisconnectType

public ConversationEventTopicCallback.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(ConversationEventTopicCallback.DisconnectTypeEnum disconnectType)

startHoldTime

public ConversationEventTopicCallback 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 ConversationEventTopicCallback dialerPreview(ConversationEventTopicDialerPreview dialerPreview)

getDialerPreview

public ConversationEventTopicDialerPreview getDialerPreview()

setDialerPreview

public void setDialerPreview(ConversationEventTopicDialerPreview dialerPreview)

voicemail

public ConversationEventTopicCallback voicemail(ConversationEventTopicVoicemail voicemail)

getVoicemail

public ConversationEventTopicVoicemail getVoicemail()

setVoicemail

public void setVoicemail(ConversationEventTopicVoicemail voicemail)

callbackNumbers

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

The name of the user requesting a callback.

getCallbackUserName

public String getCallbackUserName()

setCallbackUserName

public void setCallbackUserName(String callbackUserName)

scriptId

public ConversationEventTopicCallback scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

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

The source provider of the callback.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

timeoutSeconds

public ConversationEventTopicCallback 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 ConversationEventTopicCallback 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 ConversationEventTopicCallback 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 ConversationEventTopicCallback 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 ConversationEventTopicCallback 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 ConversationEventTopicCallback wrapup(ConversationEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public ConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(ConversationEventTopicWrapup wrapup)

afterCallWork

public ConversationEventTopicCallback afterCallWork(ConversationEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public ConversationEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(ConversationEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

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

The name displayed to recipients of the phone call.

getCallerIdName

public String getCallerIdName()

setCallerIdName

public void setCallerIdName(String callerIdName)

queueMediaSettings

public ConversationEventTopicCallback queueMediaSettings(ConversationEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public ConversationEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

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