Package com.mypurecloud.sdk.v2.model

Class ConversationEventTopicMessage

java.lang.Object

com.mypurecloud.sdk.v2.model.ConversationEventTopicMessage

All Implemented Interfaces:

Serializable

public class ConversationEventTopicMessage
extends Object
implements Serializable

ConversationEventTopicMessage

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ConversationEventTopicMessage()
ConversationEventTopicMessage(Boolean initWithEmptyList)

Method Summary

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

ConversationEventTopicMessage

public ConversationEventTopicMessage()

ConversationEventTopicMessage

public ConversationEventTopicMessage(Boolean initWithEmptyList)

Method Details

id

public ConversationEventTopicMessage id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

state

public ConversationEventTopicMessage state(ConversationEventTopicMessage.StateEnum state)

getState

public ConversationEventTopicMessage.StateEnum getState()

setState

public void setState(ConversationEventTopicMessage.StateEnum state)

initialState

public ConversationEventTopicMessage initialState(ConversationEventTopicMessage.InitialStateEnum initialState)

getInitialState

public ConversationEventTopicMessage.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(ConversationEventTopicMessage.InitialStateEnum initialState)

direction

public ConversationEventTopicMessage direction(ConversationEventTopicMessage.DirectionEnum direction)

Whether a message is inbound or outbound.

getDirection

public ConversationEventTopicMessage.DirectionEnum getDirection()

setDirection

public void setDirection(ConversationEventTopicMessage.DirectionEnum direction)

held

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

Detailed information about an error response.

getErrorInfo

public ConversationEventTopicErrorDetails getErrorInfo()

setErrorInfo

public void setErrorInfo(ConversationEventTopicErrorDetails errorInfo)

provider

public ConversationEventTopicMessage provider(String provider)

The source provider of the email.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public ConversationEventTopicMessage scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

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

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

getDisconnectType

public ConversationEventTopicMessage.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(ConversationEventTopicMessage.DisconnectTypeEnum disconnectType)

startHoldTime

public ConversationEventTopicMessage 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 ConversationEventTopicMessage 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 ConversationEventTopicMessage 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 ConversationEventTopicMessage toAddress(ConversationEventTopicAddress toAddress)

Address and name data for a call endpoint.

getToAddress

public ConversationEventTopicAddress getToAddress()

setToAddress

public void setToAddress(ConversationEventTopicAddress toAddress)

fromAddress

public ConversationEventTopicMessage fromAddress(ConversationEventTopicAddress fromAddress)

Address and name data for a call endpoint.

getFromAddress

public ConversationEventTopicAddress getFromAddress()

setFromAddress

public void setFromAddress(ConversationEventTopicAddress fromAddress)

messages

public ConversationEventTopicMessage messages(List<ConversationEventTopicMessageDetails> messages)

The messages sent on this communication channel.

getMessages

public List<ConversationEventTopicMessageDetails> getMessages()

setMessages

public void setMessages(List<ConversationEventTopicMessageDetails> messages)

messagesTranscriptUri

public ConversationEventTopicMessage messagesTranscriptUri(String messagesTranscriptUri)

the messages transcript file uri.

getMessagesTranscriptUri

public String getMessagesTranscriptUri()

setMessagesTranscriptUri

public void setMessagesTranscriptUri(String messagesTranscriptUri)

type

public ConversationEventTopicMessage type(ConversationEventTopicMessage.TypeEnum type)

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

getType

public ConversationEventTopicMessage.TypeEnum getType()

setType

public void setType(ConversationEventTopicMessage.TypeEnum type)

recipientCountry

public ConversationEventTopicMessage 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 ConversationEventTopicMessage 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 ConversationEventTopicMessage journeyContext(ConversationEventTopicJourneyContext 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 ConversationEventTopicJourneyContext getJourneyContext()

setJourneyContext

public void setJourneyContext(ConversationEventTopicJourneyContext journeyContext)

wrapup

public ConversationEventTopicMessage wrapup(ConversationEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public ConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(ConversationEventTopicWrapup wrapup)

afterCallWork

public ConversationEventTopicMessage afterCallWork(ConversationEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public ConversationEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(ConversationEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public ConversationEventTopicMessage 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 ConversationEventTopicMessage 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 ConversationEventTopicMessage 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 ConversationEventTopicMessage byoSmsIntegrationId(String byoSmsIntegrationId)

getByoSmsIntegrationId

public String getByoSmsIntegrationId()

setByoSmsIntegrationId

public void setByoSmsIntegrationId(String byoSmsIntegrationId)

queueMediaSettings

public ConversationEventTopicMessage queueMediaSettings(ConversationEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public ConversationEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(ConversationEventTopicQueueMediaSettings queueMediaSettings)

resumeTime

public ConversationEventTopicMessage resumeTime(Date resumeTime)

The time when a parked message should resume.

getResumeTime

public Date getResumeTime()

setResumeTime

public void setResumeTime(Date resumeTime)

parkTime

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