[Index]

Model: device/spark/CXContactServiceQueue

Model Details: device/spark/CXContactServiceQueue

Title Description Details
General Settings Group Assigned by FDP
  • Field Name: General Settings
  • Type: Object
Queue Name Name of the queue.
  • Field Name: General Settings.name
  • Type: String
Queue Description Description of the queue.
  • Field Name: General Settings.description
  • Type: String
Queue Type * Type of the queue.
  • Field Name: General Settings.queueType
  • Type: String
  • Choices: ["Inbound", "Outbound"]
Channel Type * The type of channel for the queue.
  • Field Name: General Settings.channelType
  • Type: String
  • Choices: ["Chat", "Email", "Social Channel", "Telephony"]
Active Status Indicates if the queue is active.
  • Field Name: General Settings.active
  • Type: Boolean
Created Time Timestamp when the queue was created.
  • Field Name: General Settings.createdTime
  • Type: String
Last Updated Time Timestamp when the queue was last updated.
  • Field Name: General Settings.lastUpdatedTime
  • Type: String
Contact Routing Settings Group Assigned by FDP
  • Field Name: Contact Routing Settings
  • Type: Object
Outdial Campaign Outdial Campaign will enable you to set-up your Contact Center for Outdial Calls.
  • Field Name: Contact Routing Settings.outdialCampaignEnabled
  • Type: Boolean
Queue Routing Type * Routing strategy for the queue.
  • Field Name: Contact Routing Settings.routingType
  • Type: String
  • Choices: ["Longest Available Agent", "Skills Based"]
Skill-Based Routing Type Type of skill-based routing.
  • Field Name: Contact Routing Settings.skillBasedRoutingType
  • Type: String
  • Choices: ["Best Available Agent", "Longest Available Agent"]
Call Distribution Groups for call distribution within the queue.
  • Field Name: callDistributionGroups.[n]
  • Type: Array
Agent Groups List of agent groups in the call distribution group.
  • Field Name: agentGroups.[n]
  • Type: Array
Team ID * Identifier for the team.
  • Field Name: Contact Routing Settings.callDistributionGroups.[n].agentGroups.[n].teamId
  • Type: String
  • Target: device/spark/CXTeam
  • Target attr: name
  • Format: uri
Duration * Duration for this group in seconds.
  • Field Name: Contact Routing Settings.callDistributionGroups.[n].duration
  • Type: Integer
Order * Order of the call distribution group.
  • Field Name: Contact Routing Settings.callDistributionGroups.[n].order
  • Type: Integer
  • Minimum: 1
Advanced Settings Group Assigned by FDP
  • Field Name: Advanced Settings
  • Type: Object
Monitoring Permitted Indicates if monitoring is permitted.
  • Field Name: Advanced Settings.monitoringPermitted
  • Type: Boolean
Recording Permitted Indicates if recording is permitted.
  • Field Name: Advanced Settings.recordingPermitted
  • Type: Boolean
Record All Calls Permitted Indicates if recording all calls is permitted.
  • Field Name: Advanced Settings.recordingAllCallsPermitted
  • Type: Boolean
Pause Recording Permitted Indicates if pausing recording is permitted.
  • Field Name: Advanced Settings.pauseRecordingPermitted
  • Type: Boolean
Recording Pause Duration Maximum pause duration for recordings in seconds.
  • Field Name: Advanced Settings.recordingPauseDuration
  • Type: Integer
Service Level Threshold Service level threshold in hours if Channel Type is EMAIL else it is seconds.
  • Field Name: Advanced Settings.serviceLevelThreshold
  • Type: Integer
Maximum Time in Queue * Maximum time a contact can spend in the queue in hours if Channel Type is EMAIL else it is seconds.
  • Field Name: Advanced Settings.maxTimeInQueue
  • Type: Integer
Music In Queue Media File Id Music In Queue Media File Id.
  • Field Name: Advanced Settings.defaultMusicInQueueMediaFileId
  • Type: String
  • Target: device/spark/CXAudioFile
  • Target attr: name
  • Format: uri
Timezone Timezone of the queue.
  • Field Name: Advanced Settings.timezone
  • Type: String
Other Settings Group Assigned by FDP
  • Field Name: Other Settings
  • Type: Object
Parking Permitted Indicates if parking is permitted.
  • Field Name: Other Settings.parkingPermitted
  • Type: Boolean
IVR Requeue URL URL for IVR requeue.
  • Field Name: Other Settings.ivrRequeueUrl
  • Type: String
Control Flow Script URL URL for the control flow script.
  • Field Name: Other Settings.controlFlowScriptUrl
  • Type: String
Overflow Number Overflow phone number in E.164 format.
  • Field Name: Other Settings.overflowNumber
  • Type: String
  • Pattern: ^\+\d{10,15}$
Check Agent Availability Whether to check agent availability.
  • Field Name: Other Settings.checkAgentAvailability
  • Type: Boolean
Maximum Active Contacts Maximum number of active contacts allowed in the queue.
  • Field Name: Other Settings.maxActiveContacts
  • Type: Integer
Social Channel Type Type of social channel.
  • Field Name: Other Settings.socialChannelType
  • Type: String
  • Choices: ["MessageBird", "Messenger", "WhatsApp"]
References Group Assigned by FDP
  • Field Name: References
  • Type: Object
References references to Address Book entries
  • Field Name: references.[n]
  • Type: Array
Name Name
  • Field Name: References.references.[n].name
  • Type: String
Reference Model Type Type
  • Field Name: References.references.[n].type
  • Type: String