Package com.mypurecloud.sdk.v2.model

Class Call

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

  • Constructor Details

    • Call

      public Call()

    • Call

      public Call(Boolean initWithEmptyList)

  • Method Details

    • state

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

    • getState

      public Call.StateEnum getState()

    • setState

      public void setState(Call.StateEnum state)

    • initialState

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

    • getInitialState

      public Call.InitialStateEnum getInitialState()

    • setInitialState

      public void setInitialState(Call.InitialStateEnum initialState)

    • id

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

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • direction

      public Call direction(Call.DirectionEnum direction)
      The direction of the call

    • getDirection

      public Call.DirectionEnum getDirection()

    • setDirection

      public void setDirection(Call.DirectionEnum direction)

    • recording

      public Call recording(Boolean recording)
      True if this call is being recorded.

    • getRecording

      public Boolean getRecording()

    • setRecording

      public void setRecording(Boolean recording)

    • recordingState

      public Call recordingState(Call.RecordingStateEnum recordingState)
      State of recording on this call.

    • getRecordingState

      public Call.RecordingStateEnum getRecordingState()

    • setRecordingState

      public void setRecordingState(Call.RecordingStateEnum recordingState)

    • recordersState

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

    • getRecordersState

      public RecordersState getRecordersState()

    • setRecordersState

      public void setRecordersState(RecordersState recordersState)

    • muted

      public Call muted(Boolean muted)
      True if this call is muted so that remote participants can't hear any audio from this end.

    • getMuted

      public Boolean getMuted()

    • setMuted

      public void setMuted(Boolean muted)

    • confined

      public Call confined(Boolean confined)
      True if this call is held and the person on this side hears hold music.

    • getConfined

      public Boolean getConfined()

    • setConfined

      public void setConfined(Boolean confined)

    • held

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

    • securePause

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

    • recordingId

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

    • getRecordingId

      public String getRecordingId()

    • setRecordingId

      public void setRecordingId(String recordingId)

    • segments

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

    • getSegments

      public List<Segment> getSegments()

    • setSegments

      public void setSegments(List<Segment> segments)

    • errorInfo

      public Call errorInfo(ErrorInfo errorInfo)

    • getErrorInfo

      public ErrorInfo getErrorInfo()

    • setErrorInfo

      public void setErrorInfo(ErrorInfo errorInfo)

    • disconnectType

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

    • getDisconnectType

      public Call.DisconnectTypeEnum getDisconnectType()

    • setDisconnectType

      public void setDisconnectType(Call.DisconnectTypeEnum disconnectType)

    • startHoldTime

      public Call startHoldTime(Date startHoldTime)
      The timestamp the call was placed on hold in the cloud clock if the call 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)

    • documentId

      public Call documentId(String documentId)
      If call is an outbound fax of a document from content management, then this is the id in content management.

    • getDocumentId

      public String getDocumentId()

    • setDocumentId

      public void setDocumentId(String documentId)

    • startAlertingTime

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

    • disconnectReasons

      public Call disconnectReasons(List<DisconnectReason> disconnectReasons)
      List of reasons that this call was disconnected. This will be set once the call disconnects.

    • getDisconnectReasons

      public List<DisconnectReason> getDisconnectReasons()

    • setDisconnectReasons

      public void setDisconnectReasons(List<DisconnectReason> disconnectReasons)

    • faxStatus

      public Call faxStatus(FaxStatus faxStatus)
      Extra information on fax transmission.

    • getFaxStatus

      public FaxStatus getFaxStatus()

    • setFaxStatus

      public void setFaxStatus(FaxStatus faxStatus)

    • provider

      public Call provider(String provider)
      The source provider for the call.

    • getProvider

      public String getProvider()

    • setProvider

      public void setProvider(String provider)

    • scriptId

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

    • getScriptId

      public String getScriptId()

    • setScriptId

      public void setScriptId(String scriptId)

    • peerId

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

    • uuiData

      public Call uuiData(String uuiData)
      User to User Information (UUI) data managed by SIP session application.

    • getUuiData

      public String getUuiData()

    • setUuiData

      public void setUuiData(String uuiData)

    • self

      public Call self(Address self)
      Address and name data for a call endpoint.

    • getSelf

      public Address getSelf()

    • setSelf

      public void setSelf(Address self)

    • other

      public Call other(Address other)
      Address and name data for a call endpoint.

    • getOther

      public Address getOther()

    • setOther

      public void setOther(Address other)

    • wrapup

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

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • afterCallWork

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

    • getAfterCallWork

      public AfterCallWork getAfterCallWork()

    • setAfterCallWork

      public void setAfterCallWork(AfterCallWork afterCallWork)

    • afterCallWorkRequired

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

    • transferSource

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

    • getTransferSource

      public String getTransferSource()

    • setTransferSource

      public void setTransferSource(String transferSource)

    • queueMediaSettings

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

    • getQueueMediaSettings

      public ConversationQueueMediaSettings getQueueMediaSettings()

    • setQueueMediaSettings

      public void setQueueMediaSettings(ConversationQueueMediaSettings queueMediaSettings)

    • disposition

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

    • getDisposition

      public Disposition getDisposition()

    • setDisposition

      public void setDisposition(Disposition disposition)

    • 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