Package com.mypurecloud.sdk.v2.model

Class CallbackMediaParticipant

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

  • Constructor Details

    • CallbackMediaParticipant

      public CallbackMediaParticipant()

    • CallbackMediaParticipant

      public CallbackMediaParticipant(Boolean initWithEmptyList)

  • Method Details

    • id

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

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • name

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

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • address

      public CallbackMediaParticipant address(String address)
      The participant address.

    • getAddress

      public String getAddress()

    • setAddress

      public void setAddress(String address)

    • startTime

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

    • getState

      public CallbackMediaParticipant.StateEnum getState()

    • setState

      public void setState(CallbackMediaParticipant.StateEnum state)

    • direction

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

    • getDirection

      public CallbackMediaParticipant.DirectionEnum getDirection()

    • setDirection

      public void setDirection(CallbackMediaParticipant.DirectionEnum direction)

    • disconnectType

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

    • getDisconnectType

      public CallbackMediaParticipant.DisconnectTypeEnum getDisconnectType()

    • setDisconnectType

      public void setDisconnectType(CallbackMediaParticipant.DisconnectTypeEnum disconnectType)

    • held

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

    • getHeld

      public Boolean getHeld()

    • setHeld

      public void setHeld(Boolean held)

    • wrapupRequired

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

    • getWrapupRequired

      public Boolean getWrapupRequired()

    • setWrapupRequired

      public void setWrapupRequired(Boolean wrapupRequired)

    • wrapupPrompt

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

    • getUser

      public DomainEntityRef getUser()

    • setUser

      public void setUser(DomainEntityRef user)

    • queue

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

    • getQueue

      public DomainEntityRef getQueue()

    • setQueue

      public void setQueue(DomainEntityRef queue)

    • team

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

    • getTeam

      public DomainEntityRef getTeam()

    • setTeam

      public void setTeam(DomainEntityRef team)

    • attributes

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

    • getProvider

      public String getProvider()

    • setProvider

      public void setProvider(String provider)

    • externalContact

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

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • peer

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

    • getFlaggedReason

      public CallbackMediaParticipant.FlaggedReasonEnum getFlaggedReason()

    • setFlaggedReason

      public void setFlaggedReason(CallbackMediaParticipant.FlaggedReasonEnum flaggedReason)

    • journeyContext

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

    • outboundPreview

      public CallbackMediaParticipant outboundPreview(DialerPreview outboundPreview)
      The outbound preview associated with this callback.

    • getOutboundPreview

      public DialerPreview getOutboundPreview()

    • setOutboundPreview

      public void setOutboundPreview(DialerPreview outboundPreview)

    • voicemail

      public CallbackMediaParticipant voicemail(Voicemail voicemail)
      The voicemail associated with this callback.

    • getVoicemail

      public Voicemail getVoicemail()

    • setVoicemail

      public void setVoicemail(Voicemail voicemail)

    • callbackNumbers

      public CallbackMediaParticipant callbackNumbers(List<String> callbackNumbers)
      The list of phone number to use for this callback.

    • getCallbackNumbers

      public List<String> getCallbackNumbers()

    • setCallbackNumbers

      public void setCallbackNumbers(List<String> callbackNumbers)

    • callbackUserName

      public CallbackMediaParticipant callbackUserName(String callbackUserName)
      The name of the callback target.

    • getCallbackUserName

      public String getCallbackUserName()

    • setCallbackUserName

      public void setCallbackUserName(String callbackUserName)

    • externalCampaign

      public CallbackMediaParticipant externalCampaign(Boolean externalCampaign)
      True if the call for the callback uses external dialing.

    • getExternalCampaign

      public Boolean getExternalCampaign()

    • setExternalCampaign

      public void setExternalCampaign(Boolean externalCampaign)

    • skipEnabled

      public CallbackMediaParticipant skipEnabled(Boolean skipEnabled)
      If true, the callback can be skipped.

    • getSkipEnabled

      public Boolean getSkipEnabled()

    • setSkipEnabled

      public void setSkipEnabled(Boolean skipEnabled)

    • timeoutSeconds

      public CallbackMediaParticipant timeoutSeconds(Integer timeoutSeconds)
      Duration in seconds before the callback will be auto-dialed.

    • getTimeoutSeconds

      public Integer getTimeoutSeconds()

    • setTimeoutSeconds

      public void setTimeoutSeconds(Integer timeoutSeconds)

    • automatedCallbackConfigId

      public CallbackMediaParticipant automatedCallbackConfigId(String automatedCallbackConfigId)
      The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal.

    • getAutomatedCallbackConfigId

      public String getAutomatedCallbackConfigId()

    • setAutomatedCallbackConfigId

      public void setAutomatedCallbackConfigId(String automatedCallbackConfigId)

    • callbackScheduledTime

      public CallbackMediaParticipant callbackScheduledTime(Date callbackScheduledTime)
      Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getCallbackScheduledTime

      public Date getCallbackScheduledTime()

    • setCallbackScheduledTime

      public void setCallbackScheduledTime(Date callbackScheduledTime)

    • 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