Package com.mypurecloud.sdk.v2.model

Class InternalMessageMediaParticipant

java.lang.Object

com.mypurecloud.sdk.v2.model.InternalMessageMediaParticipant

All Implemented Interfaces:

Serializable

public class InternalMessageMediaParticipant
extends Object
implements Serializable

InternalMessageMediaParticipant

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InternalMessageMediaParticipant.DirectionEnum	The participant's direction.
static enum	InternalMessageMediaParticipant.DisconnectTypeEnum	The reason the participant was disconnected from the conversation.
static enum	InternalMessageMediaParticipant.FlaggedReasonEnum	The reason specifying why participant flagged the conversation.
static enum	InternalMessageMediaParticipant.StateEnum	The participant's state.

Constructor Summary

Constructors

Constructor	Description
InternalMessageMediaParticipant()
InternalMessageMediaParticipant(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
InternalMessageMediaParticipant	address(String address)	The participant address.
InternalMessageMediaParticipant	alertingTimeoutMs(Integer alertingTimeoutMs)	Specifies how long the agent has to answer an interaction before being marked as not responding.
InternalMessageMediaParticipant	attributes(Map<String,String> attributes)	A list of ad-hoc attributes for the participant.
InternalMessageMediaParticipant	connectedTime(Date connectedTime)	The time when this participant went connected for this media (eg: video connected time).
InternalMessageMediaParticipant	conversationRoutingData(ConversationRoutingData conversationRoutingData)	Information on how a communication should be routed to an agent.
InternalMessageMediaParticipant	direction(InternalMessageMediaParticipant.DirectionEnum direction)	The participant's direction.
InternalMessageMediaParticipant	disconnectType(InternalMessageMediaParticipant.DisconnectTypeEnum disconnectType)	The reason the participant was disconnected from the conversation.
InternalMessageMediaParticipant	endAcwTime(Date endAcwTime)	The timestamp when this participant ended after-call work.
InternalMessageMediaParticipant	endTime(Date endTime)	The time when this participant went disconnected for this media (eg: video disconnected time).
boolean	equals(Object o)
InternalMessageMediaParticipant	errorInfo(ErrorInfo errorInfo)	If the conversation ends in error, contains additional error details.
InternalMessageMediaParticipant	externalContact(DomainEntityRef externalContact)	If this participant represents an external contact, then this will be the reference for the external contact.
InternalMessageMediaParticipant	externalContactInitialDivisionId(String externalContactInitialDivisionId)	If this participant represents an external contact, then this will be the initial division for the external contact.
InternalMessageMediaParticipant	externalOrganization(DomainEntityRef externalOrganization)	If this participant represents an external org, then this will be the reference for the external org.
InternalMessageMediaParticipant	flaggedReason(InternalMessageMediaParticipant.FlaggedReasonEnum flaggedReason)	The reason specifying why participant flagged the conversation.
InternalMessageMediaParticipant	fromAddress(Address fromAddress)	Address for the participant on the sending side of the internal message communication.
String	getAddress()
Integer	getAlertingTimeoutMs()
Map<String,String>	getAttributes()
Date	getConnectedTime()
ConversationRoutingData	getConversationRoutingData()
InternalMessageMediaParticipant.DirectionEnum	getDirection()
InternalMessageMediaParticipant.DisconnectTypeEnum	getDisconnectType()
Date	getEndAcwTime()
Date	getEndTime()
ErrorInfo	getErrorInfo()
DomainEntityRef	getExternalContact()
String	getExternalContactInitialDivisionId()
DomainEntityRef	getExternalOrganization()
InternalMessageMediaParticipant.FlaggedReasonEnum	getFlaggedReason()
Address	getFromAddress()
Boolean	getHeld()
String	getId()
String	getInternalMessageId()
JourneyContext	getJourneyContext()
List<String>	getMediaRoles()
List<InternalMessageDetails>	getMessages()
String	getName()
Date	getParkTime()
String	getPeer()
String	getProvider()
String	getPurpose()
DomainEntityRef	getQueue()
Date	getResumeTime()
DomainEntityRef	getScript()
AddressableEntityRef	getSourceUser()
Date	getStartAcwTime()
Date	getStartAlertingTime()
Date	getStartHoldTime()
Date	getStartTime()
InternalMessageMediaParticipant.StateEnum	getState()
AddressableEntityRef	getTargetUser()
DomainEntityRef	getTeam()
Address	getToAddress()
DomainEntityRef	getUser()
Wrapup	getWrapup()
String	getWrapupPrompt()
Boolean	getWrapupRequired()
Boolean	getWrapupSkipped()
Integer	getWrapupTimeoutMs()
int	hashCode()
InternalMessageMediaParticipant	held(Boolean held)	Value is true when the participant is on hold.
InternalMessageMediaParticipant	id(String id)	The unique participant ID.
InternalMessageMediaParticipant	internalMessageId(String internalMessageId)	The internal message communication ID.
InternalMessageMediaParticipant	journeyContext(JourneyContext journeyContext)	Journey System data/context that is applicable to this communication.
InternalMessageMediaParticipant	mediaRoles(List<String> mediaRoles)	List of roles this participant's media has had on the conversation, ie monitor, coach, etc
InternalMessageMediaParticipant	messages(List<InternalMessageDetails> messages)	Message instance details on the communication.
InternalMessageMediaParticipant	name(String name)	The display friendly name of the participant.
InternalMessageMediaParticipant	parkTime(Date parkTime)	The time when this participant's communication was last parked.
InternalMessageMediaParticipant	peer(String peer)	The peer communication corresponding to a matching leg for this communication.
InternalMessageMediaParticipant	provider(String provider)	The source provider for the communication.
InternalMessageMediaParticipant	purpose(String purpose)	The participant's purpose.
InternalMessageMediaParticipant	queue(DomainEntityRef queue)	The PureCloud queue for this participant.
InternalMessageMediaParticipant	resumeTime(Date resumeTime)	The time when this participant's communications will resume.
InternalMessageMediaParticipant	script(DomainEntityRef script)	The Engage script that should be used by this participant.
void	setAddress(String address)
void	setAlertingTimeoutMs(Integer alertingTimeoutMs)
void	setAttributes(Map<String,String> attributes)
void	setConnectedTime(Date connectedTime)
void	setConversationRoutingData(ConversationRoutingData conversationRoutingData)
void	setDirection(InternalMessageMediaParticipant.DirectionEnum direction)
void	setDisconnectType(InternalMessageMediaParticipant.DisconnectTypeEnum disconnectType)
void	setEndAcwTime(Date endAcwTime)
void	setEndTime(Date endTime)
void	setErrorInfo(ErrorInfo errorInfo)
void	setExternalContact(DomainEntityRef externalContact)
void	setExternalContactInitialDivisionId(String externalContactInitialDivisionId)
void	setExternalOrganization(DomainEntityRef externalOrganization)
void	setFlaggedReason(InternalMessageMediaParticipant.FlaggedReasonEnum flaggedReason)
void	setFromAddress(Address fromAddress)
void	setHeld(Boolean held)
void	setId(String id)
void	setInternalMessageId(String internalMessageId)
void	setJourneyContext(JourneyContext journeyContext)
void	setMediaRoles(List<String> mediaRoles)
void	setMessages(List<InternalMessageDetails> messages)
void	setName(String name)
void	setParkTime(Date parkTime)
void	setPeer(String peer)
void	setProvider(String provider)
void	setPurpose(String purpose)
void	setQueue(DomainEntityRef queue)
void	setResumeTime(Date resumeTime)
void	setScript(DomainEntityRef script)
void	setSourceUser(AddressableEntityRef sourceUser)
void	setStartAcwTime(Date startAcwTime)
void	setStartAlertingTime(Date startAlertingTime)
void	setStartHoldTime(Date startHoldTime)
void	setStartTime(Date startTime)
void	setState(InternalMessageMediaParticipant.StateEnum state)
void	setTargetUser(AddressableEntityRef targetUser)
void	setTeam(DomainEntityRef team)
void	setToAddress(Address toAddress)
void	setUser(DomainEntityRef user)
void	setWrapup(Wrapup wrapup)
void	setWrapupPrompt(String wrapupPrompt)
void	setWrapupRequired(Boolean wrapupRequired)
void	setWrapupSkipped(Boolean wrapupSkipped)
void	setWrapupTimeoutMs(Integer wrapupTimeoutMs)
InternalMessageMediaParticipant	sourceUser(AddressableEntityRef sourceUser)	The user participant on sending side of the internal message conversation.
InternalMessageMediaParticipant	startAcwTime(Date startAcwTime)	The timestamp when this participant started after-call work.
InternalMessageMediaParticipant	startAlertingTime(Date startAlertingTime)	The timestamp when it is first put into an alerting state.
InternalMessageMediaParticipant	startHoldTime(Date startHoldTime)	The time when this participant's hold started.
InternalMessageMediaParticipant	startTime(Date startTime)	The time when this participant first joined the conversation.
InternalMessageMediaParticipant	state(InternalMessageMediaParticipant.StateEnum state)	The participant's state.
InternalMessageMediaParticipant	targetUser(AddressableEntityRef targetUser)	The user participant on receiving side of the internal message conversation.
InternalMessageMediaParticipant	team(DomainEntityRef team)	The PureCloud team for this participant.
InternalMessageMediaParticipant	toAddress(Address toAddress)	Address for the participant on receiving side of the internal message communication.
String	toString()
InternalMessageMediaParticipant	user(DomainEntityRef user)	The PureCloud user for this participant.
InternalMessageMediaParticipant	wrapup(Wrapup wrapup)	Wrapup for this participant, if it has been applied.
InternalMessageMediaParticipant	wrapupPrompt(String wrapupPrompt)	The wrap-up prompt indicating the type of wrap-up to be performed.
InternalMessageMediaParticipant	wrapupRequired(Boolean wrapupRequired)	Value is true when the participant requires wrap-up.
InternalMessageMediaParticipant	wrapupSkipped(Boolean wrapupSkipped)	Value is true when the participant has skipped wrap-up.
InternalMessageMediaParticipant	wrapupTimeoutMs(Integer wrapupTimeoutMs)	The amount of time the participant has to complete wrap-up.

Methods inherited from class java.lang.Object

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

Constructor Details

InternalMessageMediaParticipant

public InternalMessageMediaParticipant()

InternalMessageMediaParticipant

public InternalMessageMediaParticipant(Boolean initWithEmptyList)

Method Details

id

public InternalMessageMediaParticipant id(String id)

The unique participant ID.

getId

public String getId()

setId

public void setId(String id)

name

public InternalMessageMediaParticipant name(String name)

The display friendly name of the participant.

getName

public String getName()

setName

public void setName(String name)

address

public InternalMessageMediaParticipant address(String address)

The participant address.

getAddress

public String getAddress()

setAddress

public void setAddress(String address)

startTime

public InternalMessageMediaParticipant startTime(Date startTime)

The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getStartTime

public Date getStartTime()

setStartTime

public void setStartTime(Date startTime)

startAlertingTime

public InternalMessageMediaParticipant startAlertingTime(Date startAlertingTime)

The timestamp when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getStartAlertingTime

public Date getStartAlertingTime()

setStartAlertingTime

public void setStartAlertingTime(Date startAlertingTime)

connectedTime

public InternalMessageMediaParticipant connectedTime(Date connectedTime)

The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getConnectedTime

public Date getConnectedTime()

setConnectedTime

public void setConnectedTime(Date connectedTime)

endTime

public InternalMessageMediaParticipant endTime(Date endTime)

The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getEndTime

public Date getEndTime()

setEndTime

public void setEndTime(Date endTime)

startHoldTime

public InternalMessageMediaParticipant startHoldTime(Date startHoldTime)

The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getStartHoldTime

public Date getStartHoldTime()

setStartHoldTime

public void setStartHoldTime(Date startHoldTime)

purpose

public InternalMessageMediaParticipant purpose(String purpose)

The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr

getPurpose

public String getPurpose()

setPurpose

public void setPurpose(String purpose)

state

public InternalMessageMediaParticipant state(InternalMessageMediaParticipant.StateEnum state)

The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting

getState

public InternalMessageMediaParticipant.StateEnum getState()

setState

public void setState(InternalMessageMediaParticipant.StateEnum state)

direction

public InternalMessageMediaParticipant direction(InternalMessageMediaParticipant.DirectionEnum direction)

The participant's direction. Values can be: 'inbound' or 'outbound'

getDirection

public InternalMessageMediaParticipant.DirectionEnum getDirection()

setDirection

public void setDirection(InternalMessageMediaParticipant.DirectionEnum direction)

disconnectType

public InternalMessageMediaParticipant disconnectType(InternalMessageMediaParticipant.DisconnectTypeEnum disconnectType)

The reason the participant was disconnected from the conversation.

getDisconnectType

public InternalMessageMediaParticipant.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(InternalMessageMediaParticipant.DisconnectTypeEnum disconnectType)

held

public InternalMessageMediaParticipant held(Boolean held)

Value is true when the participant is on hold.

getHeld

public Boolean getHeld()

setHeld

public void setHeld(Boolean held)

wrapupRequired

public InternalMessageMediaParticipant wrapupRequired(Boolean wrapupRequired)

Value is true when the participant requires wrap-up.

getWrapupRequired

public Boolean getWrapupRequired()

setWrapupRequired

public void setWrapupRequired(Boolean wrapupRequired)

wrapupPrompt

public InternalMessageMediaParticipant wrapupPrompt(String wrapupPrompt)

The wrap-up prompt indicating the type of wrap-up to be performed.

getWrapupPrompt

public String getWrapupPrompt()

setWrapupPrompt

public void setWrapupPrompt(String wrapupPrompt)

mediaRoles

public InternalMessageMediaParticipant mediaRoles(List<String> mediaRoles)

List of roles this participant's media has had on the conversation, ie monitor, coach, etc

getMediaRoles

public List<String> getMediaRoles()

setMediaRoles

public void setMediaRoles(List<String> mediaRoles)

user

public InternalMessageMediaParticipant user(DomainEntityRef user)

The PureCloud user for this participant.

getUser

public DomainEntityRef getUser()

setUser

public void setUser(DomainEntityRef user)

queue

public InternalMessageMediaParticipant queue(DomainEntityRef queue)

The PureCloud queue for this participant.

getQueue

public DomainEntityRef getQueue()

setQueue

public void setQueue(DomainEntityRef queue)

team

public InternalMessageMediaParticipant team(DomainEntityRef team)

The PureCloud team for this participant.

getTeam

public DomainEntityRef getTeam()

setTeam

public void setTeam(DomainEntityRef team)

attributes

public InternalMessageMediaParticipant attributes(Map<String,String> attributes)

A list of ad-hoc attributes for the participant.

getAttributes

public Map<String,String> getAttributes()

setAttributes

public void setAttributes(Map<String,String> attributes)

errorInfo

public InternalMessageMediaParticipant errorInfo(ErrorInfo errorInfo)

If the conversation ends in error, contains additional error details.

getErrorInfo

public ErrorInfo getErrorInfo()

setErrorInfo

public void setErrorInfo(ErrorInfo errorInfo)

script

public InternalMessageMediaParticipant script(DomainEntityRef script)

The Engage script that should be used by this participant.

getScript

public DomainEntityRef getScript()

setScript

public void setScript(DomainEntityRef script)

wrapupTimeoutMs

public InternalMessageMediaParticipant wrapupTimeoutMs(Integer wrapupTimeoutMs)

The amount of time the participant has to complete wrap-up.

getWrapupTimeoutMs

public Integer getWrapupTimeoutMs()

setWrapupTimeoutMs

public void setWrapupTimeoutMs(Integer wrapupTimeoutMs)

wrapupSkipped

public InternalMessageMediaParticipant wrapupSkipped(Boolean wrapupSkipped)

Value is true when the participant has skipped wrap-up.

getWrapupSkipped

public Boolean getWrapupSkipped()

setWrapupSkipped

public void setWrapupSkipped(Boolean wrapupSkipped)

alertingTimeoutMs

public InternalMessageMediaParticipant alertingTimeoutMs(Integer alertingTimeoutMs)

Specifies how long the agent has to answer an interaction before being marked as not responding.

getAlertingTimeoutMs

public Integer getAlertingTimeoutMs()

setAlertingTimeoutMs

public void setAlertingTimeoutMs(Integer alertingTimeoutMs)

provider

public InternalMessageMediaParticipant provider(String provider)

The source provider for the communication.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

externalContact

public InternalMessageMediaParticipant externalContact(DomainEntityRef externalContact)

If this participant represents an external contact, then this will be the reference for the external contact.

getExternalContact

public DomainEntityRef getExternalContact()

setExternalContact

public void setExternalContact(DomainEntityRef externalContact)

externalContactInitialDivisionId

public InternalMessageMediaParticipant externalContactInitialDivisionId(String externalContactInitialDivisionId)

If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned.

getExternalContactInitialDivisionId

public String getExternalContactInitialDivisionId()

setExternalContactInitialDivisionId

public void setExternalContactInitialDivisionId(String externalContactInitialDivisionId)

externalOrganization

public InternalMessageMediaParticipant externalOrganization(DomainEntityRef externalOrganization)

If this participant represents an external org, then this will be the reference for the external org.

getExternalOrganization

public DomainEntityRef getExternalOrganization()

setExternalOrganization

public void setExternalOrganization(DomainEntityRef externalOrganization)

wrapup

public InternalMessageMediaParticipant wrapup(Wrapup wrapup)

Wrapup for this participant, if it has been applied.

getWrapup

public Wrapup getWrapup()

setWrapup

public void setWrapup(Wrapup wrapup)

peer

public InternalMessageMediaParticipant peer(String peer)

The peer communication corresponding to a matching leg for this communication.

getPeer

public String getPeer()

setPeer

public void setPeer(String peer)

flaggedReason

public InternalMessageMediaParticipant flaggedReason(InternalMessageMediaParticipant.FlaggedReasonEnum flaggedReason)

The reason specifying why participant flagged the conversation.

getFlaggedReason

public InternalMessageMediaParticipant.FlaggedReasonEnum getFlaggedReason()

setFlaggedReason

public void setFlaggedReason(InternalMessageMediaParticipant.FlaggedReasonEnum flaggedReason)

journeyContext

public InternalMessageMediaParticipant journeyContext(JourneyContext journeyContext)

Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.

getJourneyContext

public JourneyContext getJourneyContext()

setJourneyContext

public void setJourneyContext(JourneyContext journeyContext)

conversationRoutingData

public InternalMessageMediaParticipant conversationRoutingData(ConversationRoutingData conversationRoutingData)

Information on how a communication should be routed to an agent.

getConversationRoutingData

public ConversationRoutingData getConversationRoutingData()

setConversationRoutingData

public void setConversationRoutingData(ConversationRoutingData conversationRoutingData)

startAcwTime

public InternalMessageMediaParticipant startAcwTime(Date startAcwTime)

The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getStartAcwTime

public Date getStartAcwTime()

setStartAcwTime

public void setStartAcwTime(Date startAcwTime)

endAcwTime

public InternalMessageMediaParticipant endAcwTime(Date endAcwTime)

The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getEndAcwTime

public Date getEndAcwTime()

setEndAcwTime

public void setEndAcwTime(Date endAcwTime)

parkTime

public InternalMessageMediaParticipant parkTime(Date parkTime)

The time when this participant's communication was last parked. Does not reset on resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getParkTime

public Date getParkTime()

setParkTime

public void setParkTime(Date parkTime)

resumeTime

public InternalMessageMediaParticipant resumeTime(Date resumeTime)

The time when this participant's communications will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getResumeTime

public Date getResumeTime()

setResumeTime

public void setResumeTime(Date resumeTime)

internalMessageId

public InternalMessageMediaParticipant internalMessageId(String internalMessageId)

The internal message communication ID.

getInternalMessageId

public String getInternalMessageId()

setInternalMessageId

public void setInternalMessageId(String internalMessageId)

targetUser

public InternalMessageMediaParticipant targetUser(AddressableEntityRef targetUser)

The user participant on receiving side of the internal message conversation.

getTargetUser

public AddressableEntityRef getTargetUser()

setTargetUser

public void setTargetUser(AddressableEntityRef targetUser)

sourceUser

public InternalMessageMediaParticipant sourceUser(AddressableEntityRef sourceUser)

The user participant on sending side of the internal message conversation.

getSourceUser

public AddressableEntityRef getSourceUser()

setSourceUser

public void setSourceUser(AddressableEntityRef sourceUser)

toAddress

public InternalMessageMediaParticipant toAddress(Address toAddress)

Address for the participant on receiving side of the internal message communication.

getToAddress

public Address getToAddress()

setToAddress

public void setToAddress(Address toAddress)

fromAddress

public InternalMessageMediaParticipant fromAddress(Address fromAddress)

Address for the participant on the sending side of the internal message communication.

getFromAddress

public Address getFromAddress()

setFromAddress

public void setFromAddress(Address fromAddress)

messages

public InternalMessageMediaParticipant messages(List<InternalMessageDetails> messages)

Message instance details on the communication.

getMessages

public List<InternalMessageDetails> getMessages()

setMessages

public void setMessages(List<InternalMessageDetails> messages)

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