Package com.mypurecloud.sdk.v2.model

Class CallMediaParticipant

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

  • Constructor Details

    • CallMediaParticipant

      public CallMediaParticipant()

    • CallMediaParticipant

      public CallMediaParticipant(Boolean initWithEmptyList)

  • Method Details

    • id

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

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • name

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

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • address

      public CallMediaParticipant address(String address)
      The participant address.

    • getAddress

      public String getAddress()

    • setAddress

      public void setAddress(String address)

    • startTime

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

    • getState

      public CallMediaParticipant.StateEnum getState()

    • setState

      public void setState(CallMediaParticipant.StateEnum state)

    • direction

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

    • getDirection

      public CallMediaParticipant.DirectionEnum getDirection()

    • setDirection

      public void setDirection(CallMediaParticipant.DirectionEnum direction)

    • disconnectType

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

    • getDisconnectType

      public CallMediaParticipant.DisconnectTypeEnum getDisconnectType()

    • setDisconnectType

      public void setDisconnectType(CallMediaParticipant.DisconnectTypeEnum disconnectType)

    • held

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

    • getHeld

      public Boolean getHeld()

    • setHeld

      public void setHeld(Boolean held)

    • wrapupRequired

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

    • getWrapupRequired

      public Boolean getWrapupRequired()

    • setWrapupRequired

      public void setWrapupRequired(Boolean wrapupRequired)

    • wrapupPrompt

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

    • getUser

      public DomainEntityRef getUser()

    • setUser

      public void setUser(DomainEntityRef user)

    • queue

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

    • getQueue

      public DomainEntityRef getQueue()

    • setQueue

      public void setQueue(DomainEntityRef queue)

    • team

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

    • getTeam

      public DomainEntityRef getTeam()

    • setTeam

      public void setTeam(DomainEntityRef team)

    • attributes

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

    • getProvider

      public String getProvider()

    • setProvider

      public void setProvider(String provider)

    • externalContact

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

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • peer

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

    • getFlaggedReason

      public CallMediaParticipant.FlaggedReasonEnum getFlaggedReason()

    • setFlaggedReason

      public void setFlaggedReason(CallMediaParticipant.FlaggedReasonEnum flaggedReason)

    • journeyContext

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

    • muted

      public CallMediaParticipant muted(Boolean muted)
      Value is true when the call is muted.

    • getMuted

      public Boolean getMuted()

    • setMuted

      public void setMuted(Boolean muted)

    • confined

      public CallMediaParticipant confined(Boolean confined)
      Value is true when the call is confined.

    • getConfined

      public Boolean getConfined()

    • setConfined

      public void setConfined(Boolean confined)

    • recording

      public CallMediaParticipant recording(Boolean recording)
      Value is true when the call is being recorded.

    • getRecording

      public Boolean getRecording()

    • setRecording

      public void setRecording(Boolean recording)

    • recordingState

      public CallMediaParticipant recordingState(CallMediaParticipant.RecordingStateEnum recordingState)
      The state of the call recording.

    • getRecordingState

      public CallMediaParticipant.RecordingStateEnum getRecordingState()

    • setRecordingState

      public void setRecordingState(CallMediaParticipant.RecordingStateEnum recordingState)

    • recordersState

      public CallMediaParticipant recordersState(RecordersState recordersState)
      Contains the states of different recorders.

    • getRecordersState

      public RecordersState getRecordersState()

    • setRecordersState

      public void setRecordersState(RecordersState recordersState)

    • group

      public CallMediaParticipant group(DomainEntityRef group)
      The group involved in the group ring call.

    • getGroup

      public DomainEntityRef getGroup()

    • setGroup

      public void setGroup(DomainEntityRef group)

    • ani

      public CallMediaParticipant ani(String ani)
      The call ANI.

    • getAni

      public String getAni()

    • setAni

      public void setAni(String ani)

    • dnis

      public CallMediaParticipant dnis(String dnis)
      The call DNIS.

    • getDnis

      public String getDnis()

    • setDnis

      public void setDnis(String dnis)

    • documentId

      public CallMediaParticipant documentId(String documentId)
      The ID of the Content Management document if the call is a fax.

    • getDocumentId

      public String getDocumentId()

    • setDocumentId

      public void setDocumentId(String documentId)

    • faxStatus

      public CallMediaParticipant faxStatus(FaxStatus faxStatus)
      Extra fax information if the call is a fax.

    • getFaxStatus

      public FaxStatus getFaxStatus()

    • setFaxStatus

      public void setFaxStatus(FaxStatus faxStatus)

    • monitoredParticipantId

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

    • getMonitoredParticipantId

      public String getMonitoredParticipantId()

    • setMonitoredParticipantId

      public void setMonitoredParticipantId(String monitoredParticipantId)

    • coachedParticipantId

      public CallMediaParticipant coachedParticipantId(String coachedParticipantId)
      The ID of the participant being coached when performing a call coach.

    • getCoachedParticipantId

      public String getCoachedParticipantId()

    • setCoachedParticipantId

      public void setCoachedParticipantId(String coachedParticipantId)

    • bargedParticipantId

      public CallMediaParticipant bargedParticipantId(String bargedParticipantId)
      If this participant barged in a participant's call, then this will be the id of the targeted participant.

    • getBargedParticipantId

      public String getBargedParticipantId()

    • setBargedParticipantId

      public void setBargedParticipantId(String bargedParticipantId)

    • consultParticipantId

      public CallMediaParticipant consultParticipantId(String consultParticipantId)
      The ID of the consult transfer target participant when performing a consult transfer.

    • getConsultParticipantId

      public String getConsultParticipantId()

    • setConsultParticipantId

      public void setConsultParticipantId(String consultParticipantId)

    • uuiData

      public CallMediaParticipant uuiData(String uuiData)
      User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567.

    • getUuiData

      public String getUuiData()

    • setUuiData

      public void setUuiData(String uuiData)

    • bargedTime

      public CallMediaParticipant bargedTime(Date bargedTime)
      The timestamp when this participant was connected to the barge conference in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getBargedTime

      public Date getBargedTime()

    • setBargedTime

      public void setBargedTime(Date bargedTime)

    • securePause

      public CallMediaParticipant securePause(Boolean securePause)
      True when the recording of this call is in secure pause status.

    • getSecurePause

      public Boolean getSecurePause()

    • setSecurePause

      public void setSecurePause(Boolean securePause)

    • disposition

      public CallMediaParticipant disposition(Disposition disposition)
      Call resolution data for Dialer bulk make calls commands.

    • getDisposition

      public Disposition getDisposition()

    • setDisposition

      public void setDisposition(Disposition disposition)

    • transferSource

      public CallMediaParticipant transferSource(String transferSource)
      Indicates how call reaches the agent.

    • getTransferSource

      public String getTransferSource()

    • setTransferSource

      public void setTransferSource(String transferSource)

    • 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