Package com.mypurecloud.sdk.v2.model

Class Participant

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

  • Constructor Details

    • Participant

      public Participant()

    • Participant

      public Participant(Boolean initWithEmptyList)

  • Method Details

    • id

      public Participant id(String id)
      A globally unique identifier for this conversation.

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • startTime

      public Participant startTime(Date startTime)
      The timestamp when this participant joined the conversation in the provider clock. 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)

    • endTime

      public Participant endTime(Date endTime)
      The timestamp when this participant 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

    • getEndTime

      public Date getEndTime()

    • setEndTime

      public void setEndTime(Date endTime)

    • connectedTime

      public Participant connectedTime(Date connectedTime)
      The timestamp when this participant was connected to the conversation in the provider 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)

    • name

      public Participant name(String name)
      A human readable name identifying the participant.

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • userUri

      public Participant userUri(String userUri)
      If this participant represents a user, then this will be an URI that can be used to fetch the user.

    • getUserUri

      public String getUserUri()

    • setUserUri

      public void setUserUri(String userUri)

    • userId

      public Participant userId(String userId)
      If this participant represents a user, then this will be the globally unique identifier for the user.

    • getUserId

      public String getUserId()

    • setUserId

      public void setUserId(String userId)

    • externalContactId

      public Participant externalContactId(String externalContactId)
      If this participant represents an external contact, then this will be the globally unique identifier for the external contact.

    • getExternalContactId

      public String getExternalContactId()

    • setExternalContactId

      public void setExternalContactId(String externalContactId)

    • externalContactInitialDivisionId

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

    • externalOrganizationId

      public Participant externalOrganizationId(String externalOrganizationId)
      If this participant represents an external org, then this will be the globally unique identifier for the external org.

    • getExternalOrganizationId

      public String getExternalOrganizationId()

    • setExternalOrganizationId

      public void setExternalOrganizationId(String externalOrganizationId)

    • queueId

      public Participant queueId(String queueId)
      If present, the queue id that the communication channel came in on.

    • getQueueId

      public String getQueueId()

    • setQueueId

      public void setQueueId(String queueId)

    • groupId

      public Participant groupId(String groupId)
      If present, group of users the participant represents.

    • getGroupId

      public String getGroupId()

    • setGroupId

      public void setGroupId(String groupId)

    • teamId

      public Participant teamId(String teamId)
      The team id that this participant is a member of when added to the conversation.

    • getTeamId

      public String getTeamId()

    • setTeamId

      public void setTeamId(String teamId)

    • queueName

      public Participant queueName(String queueName)
      If present, the queue name that the communication channel came in on.

    • getQueueName

      public String getQueueName()

    • setQueueName

      public void setQueueName(String queueName)

    • purpose

      public Participant purpose(String purpose)
      A well known string that specifies the purpose of this participant.

    • getPurpose

      public String getPurpose()

    • setPurpose

      public void setPurpose(String purpose)

    • participantType

      public Participant participantType(String participantType)
      A well known string that specifies the type of this participant.

    • getParticipantType

      public String getParticipantType()

    • setParticipantType

      public void setParticipantType(String participantType)

    • consultParticipantId

      public Participant consultParticipantId(String consultParticipantId)
      If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred.

    • getConsultParticipantId

      public String getConsultParticipantId()

    • setConsultParticipantId

      public void setConsultParticipantId(String consultParticipantId)

    • address

      public Participant address(String address)
      The address for the this participant. For a phone call this will be the ANI.

    • getAddress

      public String getAddress()

    • setAddress

      public void setAddress(String address)

    • ani

      public Participant ani(String ani)
      The address for the this participant. For a phone call this will be the ANI.

    • getAni

      public String getAni()

    • setAni

      public void setAni(String ani)

    • aniName

      public Participant aniName(String aniName)
      The ani-based name for this participant.

    • getAniName

      public String getAniName()

    • setAniName

      public void setAniName(String aniName)

    • dnis

      public Participant dnis(String dnis)
      The address for the this participant. For a phone call this will be the ANI.

    • getDnis

      public String getDnis()

    • setDnis

      public void setDnis(String dnis)

    • locale

      public Participant locale(String locale)
      An ISO 639 language code specifying the locale for this participant

    • getLocale

      public String getLocale()

    • setLocale

      public void setLocale(String locale)

    • wrapupRequired

      public Participant wrapupRequired(Boolean wrapupRequired)
      True iff this participant is required to enter wrapup for this conversation.

    • getWrapupRequired

      public Boolean getWrapupRequired()

    • setWrapupRequired

      public void setWrapupRequired(Boolean wrapupRequired)

    • wrapupPrompt

      public Participant wrapupPrompt(Participant.WrapupPromptEnum wrapupPrompt)
      This field controls how the UI prompts the agent for a wrapup.

    • getWrapupPrompt

      public Participant.WrapupPromptEnum getWrapupPrompt()

    • setWrapupPrompt

      public void setWrapupPrompt(Participant.WrapupPromptEnum wrapupPrompt)

    • wrapupTimeoutMs

      public Participant wrapupTimeoutMs(Integer wrapupTimeoutMs)
      Specifies how long a timed ACW session will last.

    • getWrapupTimeoutMs

      public Integer getWrapupTimeoutMs()

    • setWrapupTimeoutMs

      public void setWrapupTimeoutMs(Integer wrapupTimeoutMs)

    • wrapupSkipped

      public Participant wrapupSkipped(Boolean wrapupSkipped)
      The UI sets this field when the agent chooses to skip entering a wrapup for this participant.

    • getWrapupSkipped

      public Boolean getWrapupSkipped()

    • setWrapupSkipped

      public void setWrapupSkipped(Boolean wrapupSkipped)

    • wrapup

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

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • mediaRoles

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

    • conversationRoutingData

      public Participant conversationRoutingData(ConversationRoutingData conversationRoutingData)
      Information on how a communication should be routed to an agent.

    • getConversationRoutingData

      public ConversationRoutingData getConversationRoutingData()

    • setConversationRoutingData

      public void setConversationRoutingData(ConversationRoutingData conversationRoutingData)

    • alertingTimeoutMs

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

    • monitoredParticipantId

      public Participant monitoredParticipantId(String monitoredParticipantId)
      If this participant is a monitor, then this will be the id of the participant that is being monitored.

    • getMonitoredParticipantId

      public String getMonitoredParticipantId()

    • setMonitoredParticipantId

      public void setMonitoredParticipantId(String monitoredParticipantId)

    • coachedParticipantId

      public Participant coachedParticipantId(String coachedParticipantId)
      If this participant is a coach, then this will be the id of the participant that is being coached.

    • getCoachedParticipantId

      public String getCoachedParticipantId()

    • setCoachedParticipantId

      public void setCoachedParticipantId(String coachedParticipantId)

    • attributes

      public Participant attributes(Map<String,String> attributes)
      Additional participant attributes

    • getAttributes

      public Map<String,String> getAttributes()

    • setAttributes

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

    • calls

      public Participant calls(List<Call> calls)

    • getCalls

      public List<Call> getCalls()

    • setCalls

      public void setCalls(List<Call> calls)

    • callbacks

      public Participant callbacks(List<Callback> callbacks)

    • getCallbacks

      public List<Callback> getCallbacks()

    • setCallbacks

      public void setCallbacks(List<Callback> callbacks)

    • chats

      public Participant chats(List<ConversationChat> chats)

    • getChats

      public List<ConversationChat> getChats()

    • setChats

      public void setChats(List<ConversationChat> chats)

    • cobrowsesessions

      public Participant cobrowsesessions(List<Cobrowsesession> cobrowsesessions)

    • getCobrowsesessions

      public List<Cobrowsesession> getCobrowsesessions()

    • setCobrowsesessions

      public void setCobrowsesessions(List<Cobrowsesession> cobrowsesessions)

    • emails

      public Participant emails(List<Email> emails)

    • getEmails

      public List<Email> getEmails()

    • setEmails

      public void setEmails(List<Email> emails)

    • messages

      public Participant messages(List<Message> messages)

    • getMessages

      public List<Message> getMessages()

    • setMessages

      public void setMessages(List<Message> messages)

    • internalMessages

      public Participant internalMessages(List<InternalMessage> internalMessages)

    • getInternalMessages

      public List<InternalMessage> getInternalMessages()

    • setInternalMessages

      public void setInternalMessages(List<InternalMessage> internalMessages)

    • screenMonitorings

      public Participant screenMonitorings(List<ScreenMonitoring> screenMonitorings)

    • getScreenMonitorings

      public List<ScreenMonitoring> getScreenMonitorings()

    • setScreenMonitorings

      public void setScreenMonitorings(List<ScreenMonitoring> screenMonitorings)

    • screenshares

      public Participant screenshares(List<Screenshare> screenshares)

    • getScreenshares

      public List<Screenshare> getScreenshares()

    • setScreenshares

      public void setScreenshares(List<Screenshare> screenshares)

    • socialExpressions

      public Participant socialExpressions(List<SocialExpression> socialExpressions)

    • getSocialExpressions

      public List<SocialExpression> getSocialExpressions()

    • setSocialExpressions

      public void setSocialExpressions(List<SocialExpression> socialExpressions)

    • videos

      public Participant videos(List<Video> videos)

    • getVideos

      public List<Video> getVideos()

    • setVideos

      public void setVideos(List<Video> videos)

    • evaluations

      public Participant evaluations(List<Evaluation> evaluations)

    • getEvaluations

      public List<Evaluation> getEvaluations()

    • setEvaluations

      public void setEvaluations(List<Evaluation> evaluations)

    • screenRecordingState

      public Participant screenRecordingState(Participant.ScreenRecordingStateEnum screenRecordingState)
      The current screen recording state for this participant.

    • getScreenRecordingState

      public Participant.ScreenRecordingStateEnum getScreenRecordingState()

    • setScreenRecordingState

      public void setScreenRecordingState(Participant.ScreenRecordingStateEnum screenRecordingState)

    • flaggedReason

      public Participant flaggedReason(Participant.FlaggedReasonEnum flaggedReason)
      The reason specifying why participant flagged the conversation.

    • getFlaggedReason

      public Participant.FlaggedReasonEnum getFlaggedReason()

    • setFlaggedReason

      public void setFlaggedReason(Participant.FlaggedReasonEnum flaggedReason)

    • startAcwTime

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

    • bargedParticipantId

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

    • 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