Package com.mypurecloud.sdk.v2.model

Class MessageMediaParticipant

java.lang.Object
com.mypurecloud.sdk.v2.model.MessageMediaParticipant
All Implemented Interfaces:
Serializable
public class MessageMediaParticipant extends Object implements Serializable
MessageMediaParticipant
See Also:

  • Constructor Details

    • MessageMediaParticipant

      public MessageMediaParticipant()

    • MessageMediaParticipant

      public MessageMediaParticipant(Boolean initWithEmptyList)

  • Method Details

    • id

      public MessageMediaParticipant id(String id)
      The unique participant ID.

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • name

      public MessageMediaParticipant name(String name)
      The display friendly name of the participant.

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • address

      public MessageMediaParticipant address(String address)
      The participant address.

    • getAddress

      public String getAddress()

    • setAddress

      public void setAddress(String address)

    • startTime

      public MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant state(MessageMediaParticipant.StateEnum state)
      The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting

    • getState

      public MessageMediaParticipant.StateEnum getState()

    • setState

      public void setState(MessageMediaParticipant.StateEnum state)

    • direction

      public MessageMediaParticipant direction(MessageMediaParticipant.DirectionEnum direction)
      The participant's direction. Values can be: 'inbound' or 'outbound'

    • getDirection

      public MessageMediaParticipant.DirectionEnum getDirection()

    • setDirection

      public void setDirection(MessageMediaParticipant.DirectionEnum direction)

    • disconnectType

      public MessageMediaParticipant disconnectType(MessageMediaParticipant.DisconnectTypeEnum disconnectType)
      The reason the participant was disconnected from the conversation.

    • getDisconnectType

      public MessageMediaParticipant.DisconnectTypeEnum getDisconnectType()

    • setDisconnectType

      public void setDisconnectType(MessageMediaParticipant.DisconnectTypeEnum disconnectType)

    • held

      public MessageMediaParticipant held(Boolean held)
      Value is true when the participant is on hold.

    • getHeld

      public Boolean getHeld()

    • setHeld

      public void setHeld(Boolean held)

    • wrapupRequired

      public MessageMediaParticipant wrapupRequired(Boolean wrapupRequired)
      Value is true when the participant requires wrap-up.

    • getWrapupRequired

      public Boolean getWrapupRequired()

    • setWrapupRequired

      public void setWrapupRequired(Boolean wrapupRequired)

    • wrapupPrompt

      public MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant user(DomainEntityRef user)
      The PureCloud user for this participant.

    • getUser

      public DomainEntityRef getUser()

    • setUser

      public void setUser(DomainEntityRef user)

    • queue

      public MessageMediaParticipant queue(DomainEntityRef queue)
      The PureCloud queue for this participant.

    • getQueue

      public DomainEntityRef getQueue()

    • setQueue

      public void setQueue(DomainEntityRef queue)

    • team

      public MessageMediaParticipant team(DomainEntityRef team)
      The PureCloud team for this participant.

    • getTeam

      public DomainEntityRef getTeam()

    • setTeam

      public void setTeam(DomainEntityRef team)

    • attributes

      public MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant provider(String provider)
      The source provider for the communication.

    • getProvider

      public String getProvider()

    • setProvider

      public void setProvider(String provider)

    • externalContact

      public MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant 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 MessageMediaParticipant wrapup(Wrapup wrapup)
      Wrapup for this participant, if it has been applied.

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • peer

      public MessageMediaParticipant 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 MessageMediaParticipant flaggedReason(MessageMediaParticipant.FlaggedReasonEnum flaggedReason)
      The reason specifying why participant flagged the conversation.

    • getFlaggedReason

      public MessageMediaParticipant.FlaggedReasonEnum getFlaggedReason()

    • setFlaggedReason

      public void setFlaggedReason(MessageMediaParticipant.FlaggedReasonEnum flaggedReason)

    • journeyContext

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

    • toAddress

      public MessageMediaParticipant toAddress(Address toAddress)
      Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended.

    • getToAddress

      public Address getToAddress()

    • setToAddress

      public void setToAddress(Address toAddress)

    • fromAddress

      public MessageMediaParticipant fromAddress(Address fromAddress)
      Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended.

    • getFromAddress

      public Address getFromAddress()

    • setFromAddress

      public void setFromAddress(Address fromAddress)

    • messages

      public MessageMediaParticipant messages(List<MessageDetails> messages)
      Message instance details on the communication.

    • getMessages

      public List<MessageDetails> getMessages()

    • setMessages

      public void setMessages(List<MessageDetails> messages)

    • type

      public MessageMediaParticipant type(MessageMediaParticipant.TypeEnum type)
      Indicates the type of message platform from which the message originated.

    • getType

      public MessageMediaParticipant.TypeEnum getType()

    • setType

      public void setType(MessageMediaParticipant.TypeEnum type)

    • recipientCountry

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

    • authenticated

      public MessageMediaParticipant authenticated(Boolean authenticated)
      If true, the participant member is authenticated.

    • getAuthenticated

      public Boolean getAuthenticated()

    • setAuthenticated

      public void setAuthenticated(Boolean authenticated)

    • monitoredParticipantId

      public MessageMediaParticipant monitoredParticipantId(String monitoredParticipantId)
      The ID of the participant being monitored when performing a message monitor.

    • getMonitoredParticipantId

      public String getMonitoredParticipantId()

    • setMonitoredParticipantId

      public void setMonitoredParticipantId(String monitoredParticipantId)

    • monitoredParticipant

      public MessageMediaParticipant monitoredParticipant(AddressableEntityRef monitoredParticipant)
      The participant being monitored when performing a message monitor.

    • getMonitoredParticipant

      public AddressableEntityRef getMonitoredParticipant()

    • setMonitoredParticipant

      public void setMonitoredParticipant(AddressableEntityRef monitoredParticipant)

    • 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