Package com.mypurecloud.sdk.v2.model

Class QueueRequest

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

  • Constructor Details

    • QueueRequest

      public QueueRequest()

    • QueueRequest

      public QueueRequest(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public QueueRequest name(String name)
      The queue name

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • division

      public QueueRequest division(WritableDivision division)
      The division to which this entity belongs.

    • getDivision

      public WritableDivision getDivision()

    • setDivision

      public void setDivision(WritableDivision division)

    • description

      public QueueRequest description(String description)
      The queue description.

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • dateCreated

      public QueueRequest dateCreated(Date dateCreated)
      The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateCreated

      public Date getDateCreated()

    • setDateCreated

      public void setDateCreated(Date dateCreated)

    • dateModified

      public QueueRequest dateModified(Date dateModified)
      The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateModified

      public Date getDateModified()

    • setDateModified

      public void setDateModified(Date dateModified)

    • modifiedBy

      public QueueRequest modifiedBy(String modifiedBy)
      The ID of the user that last modified the queue.

    • getModifiedBy

      public String getModifiedBy()

    • setModifiedBy

      public void setModifiedBy(String modifiedBy)

    • createdBy

      public QueueRequest createdBy(String createdBy)
      The ID of the user that created the queue.

    • getCreatedBy

      public String getCreatedBy()

    • setCreatedBy

      public void setCreatedBy(String createdBy)

    • getMemberCount

      public Integer getMemberCount()

    • getUserMemberCount

      public Integer getUserMemberCount()

    • getJoinedMemberCount

      public Integer getJoinedMemberCount()

    • mediaSettings

      public QueueRequest mediaSettings(QueueMediaSettings mediaSettings)
      The media settings for the queue.

    • getMediaSettings

      public QueueMediaSettings getMediaSettings()

    • setMediaSettings

      public void setMediaSettings(QueueMediaSettings mediaSettings)

    • routingRules

      public QueueRequest routingRules(List<RoutingRule> routingRules)
      The routing rules for the queue, used for Preferred Agent Routing.

    • getRoutingRules

      public List<RoutingRule> getRoutingRules()

    • setRoutingRules

      public void setRoutingRules(List<RoutingRule> routingRules)

    • conditionalGroupRouting

      public QueueRequest conditionalGroupRouting(ConditionalGroupRouting conditionalGroupRouting)
      The Conditional Group Routing settings for the queue.

    • getConditionalGroupRouting

      public ConditionalGroupRouting getConditionalGroupRouting()

    • setConditionalGroupRouting

      public void setConditionalGroupRouting(ConditionalGroupRouting conditionalGroupRouting)

    • conditionalGroupActivation

      public QueueRequest conditionalGroupActivation(ConditionalGroupActivation conditionalGroupActivation)
      The Conditional Group Activation settings for the queue.

    • getConditionalGroupActivation

      public ConditionalGroupActivation getConditionalGroupActivation()

    • setConditionalGroupActivation

      public void setConditionalGroupActivation(ConditionalGroupActivation conditionalGroupActivation)

    • bullseye

      public QueueRequest bullseye(Bullseye bullseye)
      The bullseye settings for the queue.

    • getBullseye

      public Bullseye getBullseye()

    • setBullseye

      public void setBullseye(Bullseye bullseye)

    • scoringMethod

      public QueueRequest scoringMethod(QueueRequest.ScoringMethodEnum scoringMethod)
      The Scoring Method for the queue.

    • getScoringMethod

      public QueueRequest.ScoringMethodEnum getScoringMethod()

    • setScoringMethod

      public void setScoringMethod(QueueRequest.ScoringMethodEnum scoringMethod)

    • lastAgentRoutingMode

      public QueueRequest lastAgentRoutingMode(QueueRequest.LastAgentRoutingModeEnum lastAgentRoutingMode)
      The Last Agent Routing Mode for the queue.

    • getLastAgentRoutingMode

      public QueueRequest.LastAgentRoutingModeEnum getLastAgentRoutingMode()

    • setLastAgentRoutingMode

      public void setLastAgentRoutingMode(QueueRequest.LastAgentRoutingModeEnum lastAgentRoutingMode)

    • acwSettings

      public QueueRequest acwSettings(AcwSettings acwSettings)
      The ACW settings for the queue.

    • getAcwSettings

      public AcwSettings getAcwSettings()

    • setAcwSettings

      public void setAcwSettings(AcwSettings acwSettings)

    • skillEvaluationMethod

      public QueueRequest skillEvaluationMethod(QueueRequest.SkillEvaluationMethodEnum skillEvaluationMethod)
      The skill evaluation method to use when routing conversations.

    • getSkillEvaluationMethod

      public QueueRequest.SkillEvaluationMethodEnum getSkillEvaluationMethod()

    • setSkillEvaluationMethod

      public void setSkillEvaluationMethod(QueueRequest.SkillEvaluationMethodEnum skillEvaluationMethod)

    • memberGroups

      public QueueRequest memberGroups(List<MemberGroup> memberGroups)
      The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.

    • getMemberGroups

      public List<MemberGroup> getMemberGroups()

    • setMemberGroups

      public void setMemberGroups(List<MemberGroup> memberGroups)

    • queueFlow

      public QueueRequest queueFlow(DomainEntityRef queueFlow)
      The in-queue flow to use for call conversations waiting in queue.

    • getQueueFlow

      public DomainEntityRef getQueueFlow()

    • setQueueFlow

      public void setQueueFlow(DomainEntityRef queueFlow)

    • emailInQueueFlow

      public QueueRequest emailInQueueFlow(DomainEntityRef emailInQueueFlow)
      The in-queue flow to use for email conversations waiting in queue.

    • getEmailInQueueFlow

      public DomainEntityRef getEmailInQueueFlow()

    • setEmailInQueueFlow

      public void setEmailInQueueFlow(DomainEntityRef emailInQueueFlow)

    • messageInQueueFlow

      public QueueRequest messageInQueueFlow(DomainEntityRef messageInQueueFlow)
      The in-queue flow to use for message conversations waiting in queue.

    • getMessageInQueueFlow

      public DomainEntityRef getMessageInQueueFlow()

    • setMessageInQueueFlow

      public void setMessageInQueueFlow(DomainEntityRef messageInQueueFlow)

    • whisperPrompt

      public QueueRequest whisperPrompt(DomainEntityRef whisperPrompt)
      The prompt used for whisper on the queue, if configured.

    • getWhisperPrompt

      public DomainEntityRef getWhisperPrompt()

    • setWhisperPrompt

      public void setWhisperPrompt(DomainEntityRef whisperPrompt)

    • onHoldPrompt

      public QueueRequest onHoldPrompt(DomainEntityRef onHoldPrompt)
      The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.

    • getOnHoldPrompt

      public DomainEntityRef getOnHoldPrompt()

    • setOnHoldPrompt

      public void setOnHoldPrompt(DomainEntityRef onHoldPrompt)

    • autoAnswerOnly

      public QueueRequest autoAnswerOnly(Boolean autoAnswerOnly)
      Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered.

    • getAutoAnswerOnly

      public Boolean getAutoAnswerOnly()

    • setAutoAnswerOnly

      public void setAutoAnswerOnly(Boolean autoAnswerOnly)

    • cannedResponseLibraries

      public QueueRequest cannedResponseLibraries(CannedResponseLibraries cannedResponseLibraries)
      Canned response library IDs and mode with which they are associated with the queue

    • getCannedResponseLibraries

      public CannedResponseLibraries getCannedResponseLibraries()

    • setCannedResponseLibraries

      public void setCannedResponseLibraries(CannedResponseLibraries cannedResponseLibraries)

    • enableTranscription

      public QueueRequest enableTranscription(Boolean enableTranscription)
      Indicates whether voice transcription is enabled for this queue.

    • getEnableTranscription

      public Boolean getEnableTranscription()

    • setEnableTranscription

      public void setEnableTranscription(Boolean enableTranscription)

    • enableAudioMonitoring

      public QueueRequest enableAudioMonitoring(Boolean enableAudioMonitoring)
      Indicates whether audio monitoring is enabled for this queue.

    • getEnableAudioMonitoring

      public Boolean getEnableAudioMonitoring()

    • setEnableAudioMonitoring

      public void setEnableAudioMonitoring(Boolean enableAudioMonitoring)

    • enableManualAssignment

      public QueueRequest enableManualAssignment(Boolean enableManualAssignment)
      Indicates whether manual assignment is enabled for this queue.

    • getEnableManualAssignment

      public Boolean getEnableManualAssignment()

    • setEnableManualAssignment

      public void setEnableManualAssignment(Boolean enableManualAssignment)

    • agentOwnedRouting

      public QueueRequest agentOwnedRouting(AgentOwnedRouting agentOwnedRouting)
      The Agent Owned Routing settings for the queue

    • getAgentOwnedRouting

      public AgentOwnedRouting getAgentOwnedRouting()

    • setAgentOwnedRouting

      public void setAgentOwnedRouting(AgentOwnedRouting agentOwnedRouting)

    • directRouting

      public QueueRequest directRouting(DirectRouting directRouting)
      The Direct Routing settings for the queue

    • getDirectRouting

      public DirectRouting getDirectRouting()

    • setDirectRouting

      public void setDirectRouting(DirectRouting directRouting)

    • callingPartyName

      public QueueRequest callingPartyName(String callingPartyName)
      The name to use for caller identification for outbound calls from this queue.

    • getCallingPartyName

      public String getCallingPartyName()

    • setCallingPartyName

      public void setCallingPartyName(String callingPartyName)

    • callingPartyNumber

      public QueueRequest callingPartyNumber(String callingPartyNumber)
      The phone number to use for caller identification for outbound calls from this queue.

    • getCallingPartyNumber

      public String getCallingPartyNumber()

    • setCallingPartyNumber

      public void setCallingPartyNumber(String callingPartyNumber)

    • defaultScripts

      public QueueRequest defaultScripts(Map<String,Script> defaultScripts)
      The default script Ids for the communication types.

    • getDefaultScripts

      public Map<String,Script> getDefaultScripts()

    • setDefaultScripts

      public void setDefaultScripts(Map<String,Script> defaultScripts)

    • outboundMessagingAddresses

      public QueueRequest outboundMessagingAddresses(QueueMessagingAddresses outboundMessagingAddresses)
      The messaging addresses for the queue.

    • getOutboundMessagingAddresses

      public QueueMessagingAddresses getOutboundMessagingAddresses()

    • setOutboundMessagingAddresses

      public void setOutboundMessagingAddresses(QueueMessagingAddresses outboundMessagingAddresses)

    • outboundEmailAddress

      public QueueRequest outboundEmailAddress(QueueEmailAddress outboundEmailAddress)
      The default email address to use for outbound email from this queue.

    • getOutboundEmailAddress

      public QueueEmailAddress getOutboundEmailAddress()

    • setOutboundEmailAddress

      public void setOutboundEmailAddress(QueueEmailAddress outboundEmailAddress)

    • peerId

      public QueueRequest peerId(String peerId)
      The ID of an associated external queue.

    • getPeerId

      public String getPeerId()

    • setPeerId

      public void setPeerId(String peerId)

    • suppressInQueueCallRecording

      public QueueRequest suppressInQueueCallRecording(Boolean suppressInQueueCallRecording)
      Indicates whether recording in-queue calls is suppressed for this queue.

    • getSuppressInQueueCallRecording

      public Boolean getSuppressInQueueCallRecording()

    • setSuppressInQueueCallRecording

      public void setSuppressInQueueCallRecording(Boolean suppressInQueueCallRecording)

    • 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