Package com.mypurecloud.sdk.v2.model

Class CallbackMediaSettings

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

  • Constructor Details

    • CallbackMediaSettings

      public CallbackMediaSettings()

    • CallbackMediaSettings

      public CallbackMediaSettings(Boolean initWithEmptyList)

  • Method Details

    • enableAutoAnswer

      public CallbackMediaSettings enableAutoAnswer(Boolean enableAutoAnswer)
      Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings.

    • getEnableAutoAnswer

      public Boolean getEnableAutoAnswer()

    • setEnableAutoAnswer

      public void setEnableAutoAnswer(Boolean enableAutoAnswer)

    • alertingTimeoutSeconds

      public CallbackMediaSettings alertingTimeoutSeconds(Integer alertingTimeoutSeconds)
      The alerting timeout for the media type, in seconds

    • getAlertingTimeoutSeconds

      public Integer getAlertingTimeoutSeconds()

    • setAlertingTimeoutSeconds

      public void setAlertingTimeoutSeconds(Integer alertingTimeoutSeconds)

    • serviceLevel

      public CallbackMediaSettings serviceLevel(ServiceLevel serviceLevel)
      The targeted service level for the media type

    • getServiceLevel

      public ServiceLevel getServiceLevel()

    • setServiceLevel

      public void setServiceLevel(ServiceLevel serviceLevel)

    • autoAnswerAlertToneSeconds

      public CallbackMediaSettings autoAnswerAlertToneSeconds(Double autoAnswerAlertToneSeconds)
      How long to play the alerting tone for an auto-answer interaction

    • getAutoAnswerAlertToneSeconds

      public Double getAutoAnswerAlertToneSeconds()

    • setAutoAnswerAlertToneSeconds

      public void setAutoAnswerAlertToneSeconds(Double autoAnswerAlertToneSeconds)

    • manualAnswerAlertToneSeconds

      public CallbackMediaSettings manualAnswerAlertToneSeconds(Double manualAnswerAlertToneSeconds)
      How long to play the alerting tone for a manual-answer interaction

    • getManualAnswerAlertToneSeconds

      public Double getManualAnswerAlertToneSeconds()

    • setManualAnswerAlertToneSeconds

      public void setManualAnswerAlertToneSeconds(Double manualAnswerAlertToneSeconds)

    • mode

      public CallbackMediaSettings mode(CallbackMediaSettings.ModeEnum mode)
      The mode callbacks will use on this queue.

    • getMode

      public CallbackMediaSettings.ModeEnum getMode()

    • setMode

      public void setMode(CallbackMediaSettings.ModeEnum mode)

    • enableAutoDialAndEnd

      public CallbackMediaSettings enableAutoDialAndEnd(Boolean enableAutoDialAndEnd)
      Flag to enable Auto-Dial and Auto-End automation for callbacks on this queue.

    • getEnableAutoDialAndEnd

      public Boolean getEnableAutoDialAndEnd()

    • setEnableAutoDialAndEnd

      public void setEnableAutoDialAndEnd(Boolean enableAutoDialAndEnd)

    • autoDialDelaySeconds

      public CallbackMediaSettings autoDialDelaySeconds(Integer autoDialDelaySeconds)
      Time in seconds after agent connects to callback before outgoing call is auto-dialed. Allowable values in range 0 - 1200 seconds. Defaults to 300 seconds.

    • getAutoDialDelaySeconds

      public Integer getAutoDialDelaySeconds()

    • setAutoDialDelaySeconds

      public void setAutoDialDelaySeconds(Integer autoDialDelaySeconds)

    • autoEndDelaySeconds

      public CallbackMediaSettings autoEndDelaySeconds(Integer autoEndDelaySeconds)
      Time in seconds after agent disconnects from the outgoing call before the encasing callback is auto-ended. Allowable values in range 0 - 1200 seconds. Defaults to 300 seconds.

    • getAutoEndDelaySeconds

      public Integer getAutoEndDelaySeconds()

    • setAutoEndDelaySeconds

      public void setAutoEndDelaySeconds(Integer autoEndDelaySeconds)

    • pacingModifier

      public CallbackMediaSettings pacingModifier(Double pacingModifier)
      Controls the maximum number of outbound calls at one time when mode is CustomerFirst.

    • getPacingModifier

      public Double getPacingModifier()

    • setPacingModifier

      public void setPacingModifier(Double pacingModifier)

    • maxRetryCount

      public CallbackMediaSettings maxRetryCount(Integer maxRetryCount)
      Maximum number of retries that should be attempted to try and connect a customer first callback to a customer when the initial callback attempt did not connect.

    • getMaxRetryCount

      public Integer getMaxRetryCount()

    • setMaxRetryCount

      public void setMaxRetryCount(Integer maxRetryCount)

    • retryDelaySeconds

      public CallbackMediaSettings retryDelaySeconds(Integer retryDelaySeconds)
      Delay in seconds between each retry of a customer first callback.

    • getRetryDelaySeconds

      public Integer getRetryDelaySeconds()

    • setRetryDelaySeconds

      public void setRetryDelaySeconds(Integer retryDelaySeconds)

    • liveVoiceReactionType

      public CallbackMediaSettings liveVoiceReactionType(CallbackMediaSettings.LiveVoiceReactionTypeEnum liveVoiceReactionType)
      The action to take if a live voice is detected during the outbound call of a customer first callback.

    • getLiveVoiceReactionType

      public CallbackMediaSettings.LiveVoiceReactionTypeEnum getLiveVoiceReactionType()

    • setLiveVoiceReactionType

      public void setLiveVoiceReactionType(CallbackMediaSettings.LiveVoiceReactionTypeEnum liveVoiceReactionType)

    • liveVoiceFlow

      public CallbackMediaSettings liveVoiceFlow(DomainEntityRef liveVoiceFlow)
      The inbound flow to transfer to if a live voice is detected during the outbound call of a customer first callback.

    • getLiveVoiceFlow

      public DomainEntityRef getLiveVoiceFlow()

    • setLiveVoiceFlow

      public void setLiveVoiceFlow(DomainEntityRef liveVoiceFlow)

    • answeringMachineReactionType

      public CallbackMediaSettings answeringMachineReactionType(CallbackMediaSettings.AnsweringMachineReactionTypeEnum answeringMachineReactionType)
      The action to take if an answering machine is detected during the outbound call of a customer first callback.

    • getAnsweringMachineReactionType

      public CallbackMediaSettings.AnsweringMachineReactionTypeEnum getAnsweringMachineReactionType()

    • setAnsweringMachineReactionType

      public void setAnsweringMachineReactionType(CallbackMediaSettings.AnsweringMachineReactionTypeEnum answeringMachineReactionType)

    • answeringMachineFlow

      public CallbackMediaSettings answeringMachineFlow(DomainEntityRef answeringMachineFlow)
      The inbound flow to transfer to if an answering machine is detected during the outbound call of a customer first callback when answeringMachineReactionType is set to TransferToFlow.

    • getAnsweringMachineFlow

      public DomainEntityRef getAnsweringMachineFlow()

    • setAnsweringMachineFlow

      public void setAnsweringMachineFlow(DomainEntityRef answeringMachineFlow)

    • edgeGroup

      public CallbackMediaSettings edgeGroup(DomainEntityRef edgeGroup)
      The identifier of the edge group that will place the calls. Can be set to specify custom edge group instead of default one.

    • getEdgeGroup

      public DomainEntityRef getEdgeGroup()

    • setEdgeGroup

      public void setEdgeGroup(DomainEntityRef edgeGroup)

    • site

      public CallbackMediaSettings site(DomainEntityRef site)
      The identifier of the site to be used for dialing; can be set in place of an edge group.

    • getSite

      public DomainEntityRef getSite()

    • setSite

      public void setSite(DomainEntityRef site)

    • 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