Package com.mypurecloud.sdk.v2.model

Class Message

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

  • Constructor Details

    • Message

      public Message()

    • Message

      public Message(Boolean initWithEmptyList)

  • Method Details

    • state

      public Message state(Message.StateEnum state)
      The connection state of this communication.

    • getState

      public Message.StateEnum getState()

    • setState

      public void setState(Message.StateEnum state)

    • initialState

      public Message initialState(Message.InitialStateEnum initialState)
      The initial connection state of this communication.

    • getInitialState

      public Message.InitialStateEnum getInitialState()

    • setInitialState

      public void setInitialState(Message.InitialStateEnum initialState)

    • id

      public Message id(String id)
      A globally unique identifier for this communication.

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • held

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

    • segments

      public Message segments(List<Segment> segments)
      The time line of the participant's message, divided into activity segments.

    • getSegments

      public List<Segment> getSegments()

    • setSegments

      public void setSegments(List<Segment> segments)

    • direction

      public Message direction(Message.DirectionEnum direction)
      The direction of the message.

    • getDirection

      public Message.DirectionEnum getDirection()

    • setDirection

      public void setDirection(Message.DirectionEnum direction)

    • recordingId

      public Message recordingId(String recordingId)
      A globally unique identifier for the recording associated with this message.

    • getRecordingId

      public String getRecordingId()

    • setRecordingId

      public void setRecordingId(String recordingId)

    • errorInfo

      public Message errorInfo(ErrorBody errorInfo)

    • getErrorInfo

      public ErrorBody getErrorInfo()

    • setErrorInfo

      public void setErrorInfo(ErrorBody errorInfo)

    • disconnectType

      public Message disconnectType(Message.DisconnectTypeEnum disconnectType)
      System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.

    • getDisconnectType

      public Message.DisconnectTypeEnum getDisconnectType()

    • setDisconnectType

      public void setDisconnectType(Message.DisconnectTypeEnum disconnectType)

    • startHoldTime

      public Message startHoldTime(Date startHoldTime)
      The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. 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)

    • startAlertingTime

      public Message startAlertingTime(Date startAlertingTime)
      The timestamp the communication has 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 Message connectedTime(Date connectedTime)
      The timestamp when this communication was connected in the cloud clock. 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)

    • disconnectedTime

      public Message disconnectedTime(Date disconnectedTime)
      The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDisconnectedTime

      public Date getDisconnectedTime()

    • setDisconnectedTime

      public void setDisconnectedTime(Date disconnectedTime)

    • provider

      public Message provider(String provider)
      The source provider for the message.

    • getProvider

      public String getProvider()

    • setProvider

      public void setProvider(String provider)

    • authenticated

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

    • getAuthenticated

      public Boolean getAuthenticated()

    • setAuthenticated

      public void setAuthenticated(Boolean authenticated)

    • type

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

    • getType

      public Message.TypeEnum getType()

    • setType

      public void setType(Message.TypeEnum type)

    • recipientCountry

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

    • scriptId

      public Message scriptId(String scriptId)
      The UUID of the script to use.

    • getScriptId

      public String getScriptId()

    • setScriptId

      public void setScriptId(String scriptId)

    • peerId

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

    • toAddress

      public Message toAddress(Address toAddress)
      Address and name data for a call endpoint.

    • getToAddress

      public Address getToAddress()

    • setToAddress

      public void setToAddress(Address toAddress)

    • fromAddress

      public Message fromAddress(Address fromAddress)
      Address and name data for a call endpoint.

    • getFromAddress

      public Address getFromAddress()

    • setFromAddress

      public void setFromAddress(Address fromAddress)

    • messages

      public Message messages(List<MessageDetails> messages)
      The messages sent on this communication channel.

    • getMessages

      public List<MessageDetails> getMessages()

    • setMessages

      public void setMessages(List<MessageDetails> messages)

    • journeyContext

      public Message journeyContext(JourneyContext 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 JourneyContext getJourneyContext()

    • setJourneyContext

      public void setJourneyContext(JourneyContext journeyContext)

    • wrapup

      public Message wrapup(Wrapup wrapup)
      Call wrap up or disposition data.

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • afterCallWork

      public Message afterCallWork(AfterCallWork afterCallWork)
      After-call work for the communication.

    • getAfterCallWork

      public AfterCallWork getAfterCallWork()

    • setAfterCallWork

      public void setAfterCallWork(AfterCallWork afterCallWork)

    • afterCallWorkRequired

      public Message afterCallWorkRequired(Boolean afterCallWorkRequired)
      Indicates if after-call work 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 Message 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)

    • byoSmsIntegrationId

      public Message byoSmsIntegrationId(String byoSmsIntegrationId)
      The internal id representing the customer supplied sms integration message.

    • getByoSmsIntegrationId

      public String getByoSmsIntegrationId()

    • setByoSmsIntegrationId

      public void setByoSmsIntegrationId(String byoSmsIntegrationId)

    • queueMediaSettings

      public Message queueMediaSettings(ConversationQueueMediaSettings queueMediaSettings)
      Represents the queue settings for this media type.

    • getQueueMediaSettings

      public ConversationQueueMediaSettings getQueueMediaSettings()

    • setQueueMediaSettings

      public void setQueueMediaSettings(ConversationQueueMediaSettings queueMediaSettings)

    • engagementSource

      public Message engagementSource(Message.EngagementSourceEnum engagementSource)

    • getEngagementSource

      public Message.EngagementSourceEnum getEngagementSource()

    • setEngagementSource

      public void setEngagementSource(Message.EngagementSourceEnum engagementSource)

    • resumeTime

      public Message resumeTime(Date resumeTime)
      Represents the time when a parked message 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)

    • parkTime

      public Message parkTime(Date parkTime)
      Represents the time when an message was put into parked state. 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)

    • 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