Package com.mypurecloud.sdk.v2.model

Class ConversationEventTopicCall

java.lang.Object

com.mypurecloud.sdk.v2.model.ConversationEventTopicCall

All Implemented Interfaces:

Serializable

public class ConversationEventTopicCall
extends Object
implements Serializable

ConversationEventTopicCall

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ConversationEventTopicCall()
ConversationEventTopicCall(Boolean initWithEmptyList)

Method Summary

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

ConversationEventTopicCall

public ConversationEventTopicCall()

ConversationEventTopicCall

public ConversationEventTopicCall(Boolean initWithEmptyList)

Method Details

id

public ConversationEventTopicCall id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

state

public ConversationEventTopicCall state(ConversationEventTopicCall.StateEnum state)

getState

public ConversationEventTopicCall.StateEnum getState()

setState

public void setState(ConversationEventTopicCall.StateEnum state)

initialState

public ConversationEventTopicCall initialState(ConversationEventTopicCall.InitialStateEnum initialState)

getInitialState

public ConversationEventTopicCall.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(ConversationEventTopicCall.InitialStateEnum initialState)

recording

public ConversationEventTopicCall recording(Boolean recording)

True if this call is being recorded.

getRecording

public Boolean getRecording()

setRecording

public void setRecording(Boolean recording)

recordingState

public ConversationEventTopicCall recordingState(ConversationEventTopicCall.RecordingStateEnum recordingState)

State of recording on this call.

getRecordingState

public ConversationEventTopicCall.RecordingStateEnum getRecordingState()

setRecordingState

public void setRecordingState(ConversationEventTopicCall.RecordingStateEnum recordingState)

recordersState

public ConversationEventTopicCall recordersState(ConversationEventTopicRecordersState recordersState)

getRecordersState

public ConversationEventTopicRecordersState getRecordersState()

setRecordersState

public void setRecordersState(ConversationEventTopicRecordersState recordersState)

muted

public ConversationEventTopicCall 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 ConversationEventTopicCall 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 ConversationEventTopicCall 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 ConversationEventTopicCall 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 ConversationEventTopicCall errorInfo(ConversationEventTopicErrorDetails errorInfo)

getErrorInfo

public ConversationEventTopicErrorDetails getErrorInfo()

setErrorInfo

public void setErrorInfo(ConversationEventTopicErrorDetails errorInfo)

disconnectType

public ConversationEventTopicCall disconnectType(ConversationEventTopicCall.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public ConversationEventTopicCall.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(ConversationEventTopicCall.DisconnectTypeEnum disconnectType)

startHoldTime

public ConversationEventTopicCall 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 ConversationEventTopicCall direction(ConversationEventTopicCall.DirectionEnum direction)

Whether a call is inbound or outbound.

getDirection

public ConversationEventTopicCall.DirectionEnum getDirection()

setDirection

public void setDirection(ConversationEventTopicCall.DirectionEnum direction)

documentId

public ConversationEventTopicCall 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 ConversationEventTopicCall self(ConversationEventTopicAddress self)

getSelf

public ConversationEventTopicAddress getSelf()

setSelf

public void setSelf(ConversationEventTopicAddress self)

other

public ConversationEventTopicCall other(ConversationEventTopicAddress other)

Address and name data for a call endpoint.

getOther

public ConversationEventTopicAddress getOther()

setOther

public void setOther(ConversationEventTopicAddress other)

provider

public ConversationEventTopicCall provider(String provider)

The source provider of the call.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public ConversationEventTopicCall scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

public ConversationEventTopicCall 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 ConversationEventTopicCall 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 ConversationEventTopicCall 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 ConversationEventTopicCall disconnectReasons(List<ConversationEventTopicDisconnectReason> disconnectReasons)

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

getDisconnectReasons

public List<ConversationEventTopicDisconnectReason> getDisconnectReasons()

setDisconnectReasons

public void setDisconnectReasons(List<ConversationEventTopicDisconnectReason> disconnectReasons)

faxStatus

public ConversationEventTopicCall faxStatus(ConversationEventTopicFaxStatus faxStatus)

getFaxStatus

public ConversationEventTopicFaxStatus getFaxStatus()

setFaxStatus

public void setFaxStatus(ConversationEventTopicFaxStatus faxStatus)

uuiData

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

Call wrap up or disposition data.

getWrapup

public ConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(ConversationEventTopicWrapup wrapup)

afterCallWork

public ConversationEventTopicCall afterCallWork(ConversationEventTopicAfterCallWork afterCallWork)

getAfterCallWork

public ConversationEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(ConversationEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public ConversationEventTopicCall 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 ConversationEventTopicCall 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 ConversationEventTopicCall queueMediaSettings(ConversationEventTopicQueueMediaSettings queueMediaSettings)

getQueueMediaSettings

public ConversationEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(ConversationEventTopicQueueMediaSettings queueMediaSettings)

disposition

public ConversationEventTopicCall disposition(ConversationEventTopicDisposition disposition)

getDisposition

public ConversationEventTopicDisposition getDisposition()

setDisposition

public void setDisposition(ConversationEventTopicDisposition disposition)

transferSource

public ConversationEventTopicCall 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