Package com.mypurecloud.sdk.v2.model

Class QueueConversationEventTopicCall

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationEventTopicCall

All Implemented Interfaces:

Serializable

public class QueueConversationEventTopicCall
extends Object
implements Serializable

QueueConversationEventTopicCall

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueueConversationEventTopicCall.DirectionEnum	Whether a call is inbound or outbound.
static enum	QueueConversationEventTopicCall.DisconnectTypeEnum	System defined string indicating what caused the communication to disconnect.
static enum	QueueConversationEventTopicCall.InitialStateEnum	Gets or Sets initialState
static enum	QueueConversationEventTopicCall.RecordingStateEnum	State of recording on this call.
static enum	QueueConversationEventTopicCall.StateEnum	Gets or Sets state

Constructor Summary

Constructors

Constructor	Description
QueueConversationEventTopicCall()
QueueConversationEventTopicCall(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
QueueConversationEventTopicCall	afterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)
QueueConversationEventTopicCall	afterCallWorkRequired(Boolean afterCallWorkRequired)	Indicates if after-call is required for a communication.
QueueConversationEventTopicCall	agentAssistantId(String agentAssistantId)	UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation.
QueueConversationEventTopicCall	bargedTime(Date bargedTime)	The timestamp when this participant was connected to the barge conference in the provider clock.
QueueConversationEventTopicCall	confined(Boolean confined)	True if this call is held and the person on this side hears hold music.
QueueConversationEventTopicCall	connectedTime(Date connectedTime)	The timestamp when this communication was connected in the cloud clock.
QueueConversationEventTopicCall	direction(QueueConversationEventTopicCall.DirectionEnum direction)	Whether a call is inbound or outbound.
QueueConversationEventTopicCall	disconnectedTime(Date disconnectedTime)	The timestamp when this communication disconnected from the conversation in the provider clock.
QueueConversationEventTopicCall	disconnectReasons(List<QueueConversationEventTopicDisconnectReason> disconnectReasons)	List of reasons that this call was disconnected.
QueueConversationEventTopicCall	disconnectType(QueueConversationEventTopicCall.DisconnectTypeEnum disconnectType)	System defined string indicating what caused the communication to disconnect.
QueueConversationEventTopicCall	disposition(QueueConversationEventTopicDisposition disposition)
QueueConversationEventTopicCall	documentId(String documentId)	If call is a fax of a document in content management, the id of the document in content management.
boolean	equals(Object o)
QueueConversationEventTopicCall	errorInfo(QueueConversationEventTopicErrorDetails errorInfo)
QueueConversationEventTopicCall	faxStatus(QueueConversationEventTopicFaxStatus faxStatus)
QueueConversationEventTopicAfterCallWork	getAfterCallWork()
Boolean	getAfterCallWorkRequired()
String	getAgentAssistantId()
Date	getBargedTime()
Boolean	getConfined()
Date	getConnectedTime()
QueueConversationEventTopicCall.DirectionEnum	getDirection()
Date	getDisconnectedTime()
List<QueueConversationEventTopicDisconnectReason>	getDisconnectReasons()
QueueConversationEventTopicCall.DisconnectTypeEnum	getDisconnectType()
QueueConversationEventTopicDisposition	getDisposition()
String	getDocumentId()
QueueConversationEventTopicErrorDetails	getErrorInfo()
QueueConversationEventTopicFaxStatus	getFaxStatus()
Boolean	getHeld()
String	getId()
QueueConversationEventTopicCall.InitialStateEnum	getInitialState()
Boolean	getMuted()
QueueConversationEventTopicAddress	getOther()
String	getPeerId()
String	getProvider()
QueueConversationEventTopicQueueMediaSettings	getQueueMediaSettings()
QueueConversationEventTopicRecordersState	getRecordersState()
Boolean	getRecording()
QueueConversationEventTopicCall.RecordingStateEnum	getRecordingState()
String	getScriptId()
Boolean	getSecurePause()
QueueConversationEventTopicAddress	getSelf()
Date	getStartHoldTime()
QueueConversationEventTopicCall.StateEnum	getState()
String	getTransferSource()
String	getUuiData()
QueueConversationEventTopicWrapup	getWrapup()
int	hashCode()
QueueConversationEventTopicCall	held(Boolean held)	True if this call is held and the person on this side hears silence.
QueueConversationEventTopicCall	id(String id)	A globally unique identifier for this communication.
QueueConversationEventTopicCall	initialState(QueueConversationEventTopicCall.InitialStateEnum initialState)
QueueConversationEventTopicCall	muted(Boolean muted)	True if this call is muted so that remote participants can't hear any audio from this end.
QueueConversationEventTopicCall	other(QueueConversationEventTopicAddress other)	Address and name data for a call endpoint.
QueueConversationEventTopicCall	peerId(String peerId)	The id of the peer communication corresponding to a matching leg for this communication.
QueueConversationEventTopicCall	provider(String provider)	The source provider of the call.
QueueConversationEventTopicCall	queueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)
QueueConversationEventTopicCall	recordersState(QueueConversationEventTopicRecordersState recordersState)
QueueConversationEventTopicCall	recording(Boolean recording)	True if this call is being recorded.
QueueConversationEventTopicCall	recordingState(QueueConversationEventTopicCall.RecordingStateEnum recordingState)	State of recording on this call.
QueueConversationEventTopicCall	scriptId(String scriptId)	The UUID of the script to use.
QueueConversationEventTopicCall	securePause(Boolean securePause)	True when the recording of this call is in secure pause status.
QueueConversationEventTopicCall	self(QueueConversationEventTopicAddress self)
void	setAfterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)
void	setAfterCallWorkRequired(Boolean afterCallWorkRequired)
void	setAgentAssistantId(String agentAssistantId)
void	setBargedTime(Date bargedTime)
void	setConfined(Boolean confined)
void	setConnectedTime(Date connectedTime)
void	setDirection(QueueConversationEventTopicCall.DirectionEnum direction)
void	setDisconnectedTime(Date disconnectedTime)
void	setDisconnectReasons(List<QueueConversationEventTopicDisconnectReason> disconnectReasons)
void	setDisconnectType(QueueConversationEventTopicCall.DisconnectTypeEnum disconnectType)
void	setDisposition(QueueConversationEventTopicDisposition disposition)
void	setDocumentId(String documentId)
void	setErrorInfo(QueueConversationEventTopicErrorDetails errorInfo)
void	setFaxStatus(QueueConversationEventTopicFaxStatus faxStatus)
void	setHeld(Boolean held)
void	setId(String id)
void	setInitialState(QueueConversationEventTopicCall.InitialStateEnum initialState)
void	setMuted(Boolean muted)
void	setOther(QueueConversationEventTopicAddress other)
void	setPeerId(String peerId)
void	setProvider(String provider)
void	setQueueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)
void	setRecordersState(QueueConversationEventTopicRecordersState recordersState)
void	setRecording(Boolean recording)
void	setRecordingState(QueueConversationEventTopicCall.RecordingStateEnum recordingState)
void	setScriptId(String scriptId)
void	setSecurePause(Boolean securePause)
void	setSelf(QueueConversationEventTopicAddress self)
void	setStartHoldTime(Date startHoldTime)
void	setState(QueueConversationEventTopicCall.StateEnum state)
void	setTransferSource(String transferSource)
void	setUuiData(String uuiData)
void	setWrapup(QueueConversationEventTopicWrapup wrapup)
QueueConversationEventTopicCall	startHoldTime(Date startHoldTime)	The timestamp the call was placed on hold in the cloud clock if the call is currently on hold.
QueueConversationEventTopicCall	state(QueueConversationEventTopicCall.StateEnum state)
String	toString()
QueueConversationEventTopicCall	transferSource(String transferSource)	Indicates how call reaches the agent.
QueueConversationEventTopicCall	uuiData(String uuiData)	User to User Information (UUI) data managed by SIP session application.
QueueConversationEventTopicCall	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

QueueConversationEventTopicCall

public QueueConversationEventTopicCall()

QueueConversationEventTopicCall

public QueueConversationEventTopicCall(Boolean initWithEmptyList)

Method Details

id

public QueueConversationEventTopicCall id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

state

public QueueConversationEventTopicCall state(QueueConversationEventTopicCall.StateEnum state)

getState

public QueueConversationEventTopicCall.StateEnum getState()

setState

public void setState(QueueConversationEventTopicCall.StateEnum state)

initialState

public QueueConversationEventTopicCall initialState(QueueConversationEventTopicCall.InitialStateEnum initialState)

getInitialState

public QueueConversationEventTopicCall.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationEventTopicCall.InitialStateEnum initialState)

recording

public QueueConversationEventTopicCall recording(Boolean recording)

True if this call is being recorded.

getRecording

public Boolean getRecording()

setRecording

public void setRecording(Boolean recording)

recordingState

public QueueConversationEventTopicCall recordingState(QueueConversationEventTopicCall.RecordingStateEnum recordingState)

State of recording on this call.

getRecordingState

public QueueConversationEventTopicCall.RecordingStateEnum getRecordingState()

setRecordingState

public void setRecordingState(QueueConversationEventTopicCall.RecordingStateEnum recordingState)

recordersState

public QueueConversationEventTopicCall recordersState(QueueConversationEventTopicRecordersState recordersState)

getRecordersState

public QueueConversationEventTopicRecordersState getRecordersState()

setRecordersState

public void setRecordersState(QueueConversationEventTopicRecordersState recordersState)

muted

public QueueConversationEventTopicCall muted(Boolean muted)

True if this call is muted so that remote participants can't hear any audio from this end.

getMuted

public Boolean getMuted()

setMuted

public void setMuted(Boolean muted)

confined

public QueueConversationEventTopicCall confined(Boolean confined)

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

getConfined

public Boolean getConfined()

setConfined

public void setConfined(Boolean confined)

held

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

securePause

public QueueConversationEventTopicCall securePause(Boolean securePause)

True when the recording of this call is in secure pause status.

getSecurePause

public Boolean getSecurePause()

setSecurePause

public void setSecurePause(Boolean securePause)

errorInfo

public QueueConversationEventTopicCall errorInfo(QueueConversationEventTopicErrorDetails errorInfo)

getErrorInfo

public QueueConversationEventTopicErrorDetails getErrorInfo()

setErrorInfo

public void setErrorInfo(QueueConversationEventTopicErrorDetails errorInfo)

disconnectType

public QueueConversationEventTopicCall disconnectType(QueueConversationEventTopicCall.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public QueueConversationEventTopicCall.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationEventTopicCall.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationEventTopicCall startHoldTime(Date startHoldTime)

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

getStartHoldTime

public Date getStartHoldTime()

setStartHoldTime

public void setStartHoldTime(Date startHoldTime)

direction

public QueueConversationEventTopicCall direction(QueueConversationEventTopicCall.DirectionEnum direction)

Whether a call is inbound or outbound.

getDirection

public QueueConversationEventTopicCall.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationEventTopicCall.DirectionEnum direction)

documentId

public QueueConversationEventTopicCall documentId(String documentId)

If call is a fax of a document in content management, the id of the document in content management.

getDocumentId

public String getDocumentId()

setDocumentId

public void setDocumentId(String documentId)

self

public QueueConversationEventTopicCall self(QueueConversationEventTopicAddress self)

getSelf

public QueueConversationEventTopicAddress getSelf()

setSelf

public void setSelf(QueueConversationEventTopicAddress self)

other

public QueueConversationEventTopicCall other(QueueConversationEventTopicAddress other)

Address and name data for a call endpoint.

getOther

public QueueConversationEventTopicAddress getOther()

setOther

public void setOther(QueueConversationEventTopicAddress other)

provider

public QueueConversationEventTopicCall provider(String provider)

The source provider of the call.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public QueueConversationEventTopicCall scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

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

connectedTime

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

disconnectReasons

public QueueConversationEventTopicCall disconnectReasons(List<QueueConversationEventTopicDisconnectReason> disconnectReasons)

List of reasons that this call was disconnected. This will be set once the call disconnects.

getDisconnectReasons

public List<QueueConversationEventTopicDisconnectReason> getDisconnectReasons()

setDisconnectReasons

public void setDisconnectReasons(List<QueueConversationEventTopicDisconnectReason> disconnectReasons)

faxStatus

public QueueConversationEventTopicCall faxStatus(QueueConversationEventTopicFaxStatus faxStatus)

getFaxStatus

public QueueConversationEventTopicFaxStatus getFaxStatus()

setFaxStatus

public void setFaxStatus(QueueConversationEventTopicFaxStatus faxStatus)

uuiData

public QueueConversationEventTopicCall uuiData(String uuiData)

User to User Information (UUI) data managed by SIP session application.

getUuiData

public String getUuiData()

setUuiData

public void setUuiData(String uuiData)

bargedTime

public QueueConversationEventTopicCall bargedTime(Date bargedTime)

The timestamp when this participant was connected to the barge conference in the provider clock.

getBargedTime

public Date getBargedTime()

setBargedTime

public void setBargedTime(Date bargedTime)

wrapup

public QueueConversationEventTopicCall wrapup(QueueConversationEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationEventTopicWrapup wrapup)

afterCallWork

public QueueConversationEventTopicCall afterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)

getAfterCallWork

public QueueConversationEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

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

agentAssistantId

public QueueConversationEventTopicCall agentAssistantId(String agentAssistantId)

UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation.

getAgentAssistantId

public String getAgentAssistantId()

setAgentAssistantId

public void setAgentAssistantId(String agentAssistantId)

queueMediaSettings

public QueueConversationEventTopicCall queueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)

getQueueMediaSettings

public QueueConversationEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)

disposition

public QueueConversationEventTopicCall disposition(QueueConversationEventTopicDisposition disposition)

getDisposition

public QueueConversationEventTopicDisposition getDisposition()

setDisposition

public void setDisposition(QueueConversationEventTopicDisposition disposition)

transferSource

public QueueConversationEventTopicCall transferSource(String transferSource)

Indicates how call reaches the agent.

getTransferSource

public String getTransferSource()

setTransferSource

public void setTransferSource(String transferSource)

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