Package com.mypurecloud.sdk.v2.model

Class QueueConversationEventTopicMessage

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationEventTopicMessage

All Implemented Interfaces:

Serializable

public class QueueConversationEventTopicMessage
extends Object
implements Serializable

QueueConversationEventTopicMessage

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueueConversationEventTopicMessage.DirectionEnum	Whether a message is inbound or outbound.
static enum	QueueConversationEventTopicMessage.DisconnectTypeEnum	System defined string indicating what caused the communication to disconnect.
static enum	QueueConversationEventTopicMessage.InitialStateEnum	Gets or Sets initialState
static enum	QueueConversationEventTopicMessage.StateEnum	Gets or Sets state
static enum	QueueConversationEventTopicMessage.TypeEnum	Indicates the type of message platform from which the message originated.

Constructor Summary

Constructors

Constructor	Description
QueueConversationEventTopicMessage()
QueueConversationEventTopicMessage(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
QueueConversationEventTopicMessage	afterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)	A communication's after-call work data.
QueueConversationEventTopicMessage	afterCallWorkRequired(Boolean afterCallWorkRequired)	Indicates if after-call is required for a communication.
QueueConversationEventTopicMessage	agentAssistantId(String agentAssistantId)	UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation.
QueueConversationEventTopicMessage	byoSmsIntegrationId(String byoSmsIntegrationId)
QueueConversationEventTopicMessage	connectedTime(Date connectedTime)	The timestamp when this communication was connected in the cloud clock.
QueueConversationEventTopicMessage	direction(QueueConversationEventTopicMessage.DirectionEnum direction)	Whether a message is inbound or outbound.
QueueConversationEventTopicMessage	disconnectedTime(Date disconnectedTime)	The timestamp when this communication disconnected from the conversation in the provider clock.
QueueConversationEventTopicMessage	disconnectType(QueueConversationEventTopicMessage.DisconnectTypeEnum disconnectType)	System defined string indicating what caused the communication to disconnect.
QueueConversationEventTopicMessage	engagementSource(String engagementSource)	Provide more visibility into what integrations customers are creating with Open Messaging.
boolean	equals(Object o)
QueueConversationEventTopicMessage	errorInfo(QueueConversationEventTopicErrorDetails errorInfo)	Detailed information about an error response.
QueueConversationEventTopicMessage	fromAddress(QueueConversationEventTopicAddress fromAddress)	Address and name data for a call endpoint.
QueueConversationEventTopicAfterCallWork	getAfterCallWork()
Boolean	getAfterCallWorkRequired()
String	getAgentAssistantId()
String	getByoSmsIntegrationId()
Date	getConnectedTime()
QueueConversationEventTopicMessage.DirectionEnum	getDirection()
Date	getDisconnectedTime()
QueueConversationEventTopicMessage.DisconnectTypeEnum	getDisconnectType()
String	getEngagementSource()
QueueConversationEventTopicErrorDetails	getErrorInfo()
QueueConversationEventTopicAddress	getFromAddress()
Boolean	getHeld()
String	getId()
QueueConversationEventTopicMessage.InitialStateEnum	getInitialState()
QueueConversationEventTopicJourneyContext	getJourneyContext()
List<QueueConversationEventTopicMessageDetails>	getMessages()
String	getMessagesTranscriptUri()
Date	getParkTime()
String	getPeerId()
String	getProvider()
QueueConversationEventTopicQueueMediaSettings	getQueueMediaSettings()
String	getRecipientCountry()
String	getRecipientType()
Date	getResumeTime()
String	getScriptId()
Date	getStartHoldTime()
QueueConversationEventTopicMessage.StateEnum	getState()
QueueConversationEventTopicAddress	getToAddress()
QueueConversationEventTopicMessage.TypeEnum	getType()
QueueConversationEventTopicWrapup	getWrapup()
int	hashCode()
QueueConversationEventTopicMessage	held(Boolean held)	True if this call is held and the person on this side hears silence.
QueueConversationEventTopicMessage	id(String id)	A globally unique identifier for this communication.
QueueConversationEventTopicMessage	initialState(QueueConversationEventTopicMessage.InitialStateEnum initialState)
QueueConversationEventTopicMessage	journeyContext(QueueConversationEventTopicJourneyContext journeyContext)	A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).
QueueConversationEventTopicMessage	messages(List<QueueConversationEventTopicMessageDetails> messages)	The messages sent on this communication channel.
QueueConversationEventTopicMessage	messagesTranscriptUri(String messagesTranscriptUri)	the messages transcript file uri.
QueueConversationEventTopicMessage	parkTime(Date parkTime)	The time when an parked message was parked.
QueueConversationEventTopicMessage	peerId(String peerId)	The id of the peer communication corresponding to a matching leg for this communication.
QueueConversationEventTopicMessage	provider(String provider)	The source provider of the email.
QueueConversationEventTopicMessage	queueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)	Represents the queue setting for this media.
QueueConversationEventTopicMessage	recipientCountry(String recipientCountry)	Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.
QueueConversationEventTopicMessage	recipientType(String recipientType)	The type of the recipient.
QueueConversationEventTopicMessage	resumeTime(Date resumeTime)	The time when a parked message should resume.
QueueConversationEventTopicMessage	scriptId(String scriptId)	The UUID of the script to use.
void	setAfterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)
void	setAfterCallWorkRequired(Boolean afterCallWorkRequired)
void	setAgentAssistantId(String agentAssistantId)
void	setByoSmsIntegrationId(String byoSmsIntegrationId)
void	setConnectedTime(Date connectedTime)
void	setDirection(QueueConversationEventTopicMessage.DirectionEnum direction)
void	setDisconnectedTime(Date disconnectedTime)
void	setDisconnectType(QueueConversationEventTopicMessage.DisconnectTypeEnum disconnectType)
void	setEngagementSource(String engagementSource)
void	setErrorInfo(QueueConversationEventTopicErrorDetails errorInfo)
void	setFromAddress(QueueConversationEventTopicAddress fromAddress)
void	setHeld(Boolean held)
void	setId(String id)
void	setInitialState(QueueConversationEventTopicMessage.InitialStateEnum initialState)
void	setJourneyContext(QueueConversationEventTopicJourneyContext journeyContext)
void	setMessages(List<QueueConversationEventTopicMessageDetails> messages)
void	setMessagesTranscriptUri(String messagesTranscriptUri)
void	setParkTime(Date parkTime)
void	setPeerId(String peerId)
void	setProvider(String provider)
void	setQueueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)
void	setRecipientCountry(String recipientCountry)
void	setRecipientType(String recipientType)
void	setResumeTime(Date resumeTime)
void	setScriptId(String scriptId)
void	setStartHoldTime(Date startHoldTime)
void	setState(QueueConversationEventTopicMessage.StateEnum state)
void	setToAddress(QueueConversationEventTopicAddress toAddress)
void	setType(QueueConversationEventTopicMessage.TypeEnum type)
void	setWrapup(QueueConversationEventTopicWrapup wrapup)
QueueConversationEventTopicMessage	startHoldTime(Date startHoldTime)	The timestamp the email was placed on hold in the cloud clock if the email is currently on hold.
QueueConversationEventTopicMessage	state(QueueConversationEventTopicMessage.StateEnum state)
QueueConversationEventTopicMessage	toAddress(QueueConversationEventTopicAddress toAddress)	Address and name data for a call endpoint.
String	toString()
QueueConversationEventTopicMessage	type(QueueConversationEventTopicMessage.TypeEnum type)	Indicates the type of message platform from which the message originated.
QueueConversationEventTopicMessage	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

QueueConversationEventTopicMessage

public QueueConversationEventTopicMessage()

QueueConversationEventTopicMessage

public QueueConversationEventTopicMessage(Boolean initWithEmptyList)

Method Details

id

public QueueConversationEventTopicMessage id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

state

public QueueConversationEventTopicMessage state(QueueConversationEventTopicMessage.StateEnum state)

getState

public QueueConversationEventTopicMessage.StateEnum getState()

setState

public void setState(QueueConversationEventTopicMessage.StateEnum state)

initialState

public QueueConversationEventTopicMessage initialState(QueueConversationEventTopicMessage.InitialStateEnum initialState)

getInitialState

public QueueConversationEventTopicMessage.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationEventTopicMessage.InitialStateEnum initialState)

direction

public QueueConversationEventTopicMessage direction(QueueConversationEventTopicMessage.DirectionEnum direction)

Whether a message is inbound or outbound.

getDirection

public QueueConversationEventTopicMessage.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationEventTopicMessage.DirectionEnum direction)

held

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

errorInfo

public QueueConversationEventTopicMessage errorInfo(QueueConversationEventTopicErrorDetails errorInfo)

Detailed information about an error response.

getErrorInfo

public QueueConversationEventTopicErrorDetails getErrorInfo()

setErrorInfo

public void setErrorInfo(QueueConversationEventTopicErrorDetails errorInfo)

provider

public QueueConversationEventTopicMessage provider(String provider)

The source provider of the email.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public QueueConversationEventTopicMessage scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

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

disconnectType

public QueueConversationEventTopicMessage disconnectType(QueueConversationEventTopicMessage.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public QueueConversationEventTopicMessage.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationEventTopicMessage.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationEventTopicMessage startHoldTime(Date startHoldTime)

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

getStartHoldTime

public Date getStartHoldTime()

setStartHoldTime

public void setStartHoldTime(Date startHoldTime)

connectedTime

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

toAddress

public QueueConversationEventTopicMessage toAddress(QueueConversationEventTopicAddress toAddress)

Address and name data for a call endpoint.

getToAddress

public QueueConversationEventTopicAddress getToAddress()

setToAddress

public void setToAddress(QueueConversationEventTopicAddress toAddress)

fromAddress

public QueueConversationEventTopicMessage fromAddress(QueueConversationEventTopicAddress fromAddress)

Address and name data for a call endpoint.

getFromAddress

public QueueConversationEventTopicAddress getFromAddress()

setFromAddress

public void setFromAddress(QueueConversationEventTopicAddress fromAddress)

messages

public QueueConversationEventTopicMessage messages(List<QueueConversationEventTopicMessageDetails> messages)

The messages sent on this communication channel.

getMessages

public List<QueueConversationEventTopicMessageDetails> getMessages()

setMessages

public void setMessages(List<QueueConversationEventTopicMessageDetails> messages)

messagesTranscriptUri

public QueueConversationEventTopicMessage messagesTranscriptUri(String messagesTranscriptUri)

the messages transcript file uri.

getMessagesTranscriptUri

public String getMessagesTranscriptUri()

setMessagesTranscriptUri

public void setMessagesTranscriptUri(String messagesTranscriptUri)

type

public QueueConversationEventTopicMessage type(QueueConversationEventTopicMessage.TypeEnum type)

Indicates the type of message platform from which the message originated.

getType

public QueueConversationEventTopicMessage.TypeEnum getType()

setType

public void setType(QueueConversationEventTopicMessage.TypeEnum type)

recipientCountry

public QueueConversationEventTopicMessage recipientCountry(String recipientCountry)

Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.

getRecipientCountry

public String getRecipientCountry()

setRecipientCountry

public void setRecipientCountry(String recipientCountry)

recipientType

public QueueConversationEventTopicMessage recipientType(String recipientType)

The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.

getRecipientType

public String getRecipientType()

setRecipientType

public void setRecipientType(String recipientType)

journeyContext

public QueueConversationEventTopicMessage journeyContext(QueueConversationEventTopicJourneyContext journeyContext)

A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).

getJourneyContext

public QueueConversationEventTopicJourneyContext getJourneyContext()

setJourneyContext

public void setJourneyContext(QueueConversationEventTopicJourneyContext journeyContext)

wrapup

public QueueConversationEventTopicMessage wrapup(QueueConversationEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationEventTopicWrapup wrapup)

afterCallWork

public QueueConversationEventTopicMessage afterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public QueueConversationEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

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

engagementSource

public QueueConversationEventTopicMessage engagementSource(String engagementSource)

Provide more visibility into what integrations customers are creating with Open Messaging. String values are defined in the Constants.java named ENGAGEMENT_SOURCE_*

getEngagementSource

public String getEngagementSource()

setEngagementSource

public void setEngagementSource(String engagementSource)

byoSmsIntegrationId

public QueueConversationEventTopicMessage byoSmsIntegrationId(String byoSmsIntegrationId)

getByoSmsIntegrationId

public String getByoSmsIntegrationId()

setByoSmsIntegrationId

public void setByoSmsIntegrationId(String byoSmsIntegrationId)

queueMediaSettings

public QueueConversationEventTopicMessage queueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public QueueConversationEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)

resumeTime

public QueueConversationEventTopicMessage resumeTime(Date resumeTime)

The time when a parked message should resume.

getResumeTime

public Date getResumeTime()

setResumeTime

public void setResumeTime(Date resumeTime)

parkTime

public QueueConversationEventTopicMessage parkTime(Date parkTime)

The time when an parked message was parked.

getParkTime

public Date getParkTime()

setParkTime

public void setParkTime(Date parkTime)

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