Package com.mypurecloud.sdk.v2.model

Class Conversation

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

  • Constructor Details

    • Conversation

      public Conversation()

    • Conversation

      public Conversation(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public Conversation name(String name)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • externalTag

      public Conversation externalTag(String externalTag)
      The external tag associated with the conversation.

    • getExternalTag

      public String getExternalTag()

    • setExternalTag

      public void setExternalTag(String externalTag)

    • startTime

      public Conversation startTime(Date startTime)
      The time when the conversation started. This will be the time when the first participant 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)

    • endTime

      public Conversation endTime(Date endTime)
      The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. 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)

    • address

      public Conversation address(String address)
      The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound.

    • getAddress

      public String getAddress()

    • setAddress

      public void setAddress(String address)

    • participants

      public Conversation participants(List<Participant> participants)
      The list of all participants in the conversation.

    • getParticipants

      public List<Participant> getParticipants()

    • setParticipants

      public void setParticipants(List<Participant> participants)

    • conversationIds

      public Conversation conversationIds(List<String> conversationIds)
      A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.

    • getConversationIds

      public List<String> getConversationIds()

    • setConversationIds

      public void setConversationIds(List<String> conversationIds)

    • maxParticipants

      public Conversation maxParticipants(Integer maxParticipants)
      If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.

    • getMaxParticipants

      public Integer getMaxParticipants()

    • setMaxParticipants

      public void setMaxParticipants(Integer maxParticipants)

    • recordingState

      public Conversation recordingState(Conversation.RecordingStateEnum recordingState)
      On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.

    • getRecordingState

      public Conversation.RecordingStateEnum getRecordingState()

    • setRecordingState

      public void setRecordingState(Conversation.RecordingStateEnum recordingState)

    • state

      public Conversation state(Conversation.StateEnum state)
      On update, 'disconnected' will disconnect the conversation. No other values are valid. When reading conversations, this field will never have a value present.

    • getState

      public Conversation.StateEnum getState()

    • setState

      public void setState(Conversation.StateEnum state)

    • divisions

      public Conversation divisions(List<ConversationDivisionMembership> divisions)
      Identifiers of divisions associated with this conversation

    • getDivisions

      public List<ConversationDivisionMembership> getDivisions()

    • setDivisions

      public void setDivisions(List<ConversationDivisionMembership> divisions)

    • recentTransfers

      public Conversation recentTransfers(List<TransferResponse> recentTransfers)
      The list of the most recent 20 transfer commands applied to this conversation.

    • getRecentTransfers

      public List<TransferResponse> getRecentTransfers()

    • setRecentTransfers

      public void setRecentTransfers(List<TransferResponse> recentTransfers)

    • securePause

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

    • getSecurePause

      public Boolean getSecurePause()

    • setSecurePause

      public void setSecurePause(Boolean securePause)

    • utilizationLabelId

      public Conversation utilizationLabelId(String utilizationLabelId)
      An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level

    • getUtilizationLabelId

      public String getUtilizationLabelId()

    • setUtilizationLabelId

      public void setUtilizationLabelId(String utilizationLabelId)

    • inactivityTimeout

      public Conversation inactivityTimeout(Date inactivityTimeout)
      The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getInactivityTimeout

      public Date getInactivityTimeout()

    • setInactivityTimeout

      public void setInactivityTimeout(Date inactivityTimeout)

    • getSelfUri

      public String getSelfUri()

    • 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