Package com.mypurecloud.sdk.v2.model

Class Callback

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

  • Constructor Details

    • Callback

      public Callback()

    • Callback

      public Callback(Boolean initWithEmptyList)

  • Method Details

    • state

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

    • getState

      public Callback.StateEnum getState()

    • setState

      public void setState(Callback.StateEnum state)

    • initialState

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

    • getInitialState

      public Callback.InitialStateEnum getInitialState()

    • setInitialState

      public void setInitialState(Callback.InitialStateEnum initialState)

    • id

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

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • segments

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

    • getSegments

      public List<Segment> getSegments()

    • setSegments

      public void setSegments(List<Segment> segments)

    • direction

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

    • getDirection

      public Callback.DirectionEnum getDirection()

    • setDirection

      public void setDirection(Callback.DirectionEnum direction)

    • held

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

    • disconnectType

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

    • getDisconnectType

      public Callback.DisconnectTypeEnum getDisconnectType()

    • setDisconnectType

      public void setDisconnectType(Callback.DisconnectTypeEnum disconnectType)

    • startHoldTime

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

    • dialerPreview

      public Callback dialerPreview(DialerPreview dialerPreview)
      The preview data to be used when this callback is a Preview.

    • getDialerPreview

      public DialerPreview getDialerPreview()

    • setDialerPreview

      public void setDialerPreview(DialerPreview dialerPreview)

    • voicemail

      public Callback voicemail(Voicemail voicemail)
      The voicemail data to be used when this callback is an ACD voicemail.

    • getVoicemail

      public Voicemail getVoicemail()

    • setVoicemail

      public void setVoicemail(Voicemail voicemail)

    • callbackNumbers

      public Callback callbackNumbers(List<String> callbackNumbers)
      The phone number(s) to use to place the callback.

    • getCallbackNumbers

      public List<String> getCallbackNumbers()

    • setCallbackNumbers

      public void setCallbackNumbers(List<String> callbackNumbers)

    • callbackUserName

      public Callback callbackUserName(String callbackUserName)
      The name of the user requesting a callback.

    • getCallbackUserName

      public String getCallbackUserName()

    • setCallbackUserName

      public void setCallbackUserName(String callbackUserName)

    • scriptId

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

    • getScriptId

      public String getScriptId()

    • setScriptId

      public void setScriptId(String scriptId)

    • externalCampaign

      public Callback 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 Callback skipEnabled(Boolean skipEnabled)
      True if the ability to skip a callback should be enabled.

    • getSkipEnabled

      public Boolean getSkipEnabled()

    • setSkipEnabled

      public void setSkipEnabled(Boolean skipEnabled)

    • timeoutSeconds

      public Callback timeoutSeconds(Integer timeoutSeconds)
      The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled.

    • getTimeoutSeconds

      public Integer getTimeoutSeconds()

    • setTimeoutSeconds

      public void setTimeoutSeconds(Integer timeoutSeconds)

    • startAlertingTime

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

    • callbackScheduledTime

      public Callback callbackScheduledTime(Date callbackScheduledTime)
      The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. 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)

    • automatedCallbackConfigId

      public Callback automatedCallbackConfigId(String automatedCallbackConfigId)
      The id of the config for automatically placing the callback (and handling the disposition). If null, 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)

    • provider

      public Callback provider(String provider)
      The source provider for the callback.

    • getProvider

      public String getProvider()

    • setProvider

      public void setProvider(String provider)

    • peerId

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

    • wrapup

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

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • afterCallWork

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

    • getAfterCallWork

      public AfterCallWork getAfterCallWork()

    • setAfterCallWork

      public void setAfterCallWork(AfterCallWork afterCallWork)

    • afterCallWorkRequired

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

    • callerId

      public Callback callerId(String callerId)
      The phone number displayed to recipients of the phone call. The value should conform to the E164 format.

    • getCallerId

      public String getCallerId()

    • setCallerId

      public void setCallerId(String callerId)

    • callerIdName

      public Callback callerIdName(String callerIdName)
      The name displayed to recipients of the phone call.

    • getCallerIdName

      public String getCallerIdName()

    • setCallerIdName

      public void setCallerIdName(String callerIdName)

    • queueMediaSettings

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

    • getQueueMediaSettings

      public ConversationQueueMediaSettings getQueueMediaSettings()

    • setQueueMediaSettings

      public void setQueueMediaSettings(ConversationQueueMediaSettings queueMediaSettings)

    • 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