Webex · Schema

ContactServiceQueueBulkExportDTO

DTO for bulk export of Contact Service Queue data.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	Name of the Contact Service Queue.
description	string	A short description of the queue.
type	string	The queue type, such as INBOUND or OUTBOUND.
channelType	string	The channel type of the queue.
routingType	string	The routing type for this queue.
monitoringPermitted	boolean	Indicates whether monitoring is permitted.
parkingPermitted	boolean	Indicates whether parking is permitted.
recordingPermitted	boolean	Indicates whether recording is permitted.
recordingAllCallsPermitted	boolean	Indicates whether recording all calls is permitted.
pauseRecordingPermitted	boolean	Indicates whether pausing the recording is permitted.
recordingPauseDuration	integer	The duration in seconds of pause in recording.
maxTimeInQueue	integer	The time in seconds after which the queued request is distributed to the overflow number.
defaultMusicInQueueMediaFile	string	The default audio file played for calls when they arrive or are waiting in queue.
serviceLevelThreshold	string	The time in seconds before the system flags a request as outside the service level.
timezone	string	The time zone used by routing strategies for this queue.
imiOrgType	string	The IMI organization type associated with this queue.
skillBasedRoutingType	string	The skill-based routing type for this queue.
outdialCampaignEnabled	boolean	Indicates whether outdial campaign is enabled.
queueRoutingType	string	The queue routing type.
callDistributionGroups	array	The call distribution groups configured for this queue.
queueSkillRequirements	array	The skill requirements configured for this queue.
agents	array	The list of agent IDs assigned to this queue.
manuallyAssignable	boolean	Indicates whether the queue can be manually assigned.
queueLevelSummariesInclusion	string	Queue level summaries inclusion type.
queueLevelSentimentAnalysisInclusion	string	Queue level sentiment analysis inclusion type.
queueLevelPredictedWaitTimeInclusion	string	Queue level predicted wait time inclusion type.
queueLevelAutoCsatInclusion	string	Queue level auto CSAT inclusion type.
queueLevelRealTimeTranscriptionsInclusion	string	Queue level real time transcriptions inclusion type.
assistantSkill	object	The assistant skill mapping for this queue.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ContactServiceQueueBulkExportDTO",
  "title": "ContactServiceQueueBulkExportDTO",
  "type": "object",
  "description": "DTO for bulk export of Contact Service Queue data.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the Contact Service Queue."
    },
    "description": {
      "type": "string",
      "description": "A short description of the queue."
    },
    "type": {
      "type": "string",
      "description": "The queue type, such as INBOUND or OUTBOUND."
    },
    "channelType": {
      "type": "string",
      "description": "The channel type of the queue."
    },
    "routingType": {
      "type": "string",
      "description": "The routing type for this queue."
    },
    "monitoringPermitted": {
      "type": "boolean",
      "description": "Indicates whether monitoring is permitted."
    },
    "parkingPermitted": {
      "type": "boolean",
      "description": "Indicates whether parking is permitted."
    },
    "recordingPermitted": {
      "type": "boolean",
      "description": "Indicates whether recording is permitted."
    },
    "recordingAllCallsPermitted": {
      "type": "boolean",
      "description": "Indicates whether recording all calls is permitted."
    },
    "pauseRecordingPermitted": {
      "type": "boolean",
      "description": "Indicates whether pausing the recording is permitted."
    },
    "recordingPauseDuration": {
      "type": "integer",
      "format": "int32",
      "description": "The duration in seconds of pause in recording."
    },
    "maxTimeInQueue": {
      "type": "integer",
      "format": "int32",
      "description": "The time in seconds after which the queued request is distributed to the overflow number."
    },
    "defaultMusicInQueueMediaFile": {
      "type": "string",
      "description": "The default audio file played for calls when they arrive or are waiting in queue."
    },
    "serviceLevelThreshold": {
      "type": "string",
      "description": "The time in seconds before the system flags a request as outside the service level."
    },
    "timezone": {
      "type": "string",
      "description": "The time zone used by routing strategies for this queue."
    },
    "imiOrgType": {
      "type": "string",
      "description": "The IMI organization type associated with this queue."
    },
    "skillBasedRoutingType": {
      "type": "string",
      "description": "The skill-based routing type for this queue."
    },
    "outdialCampaignEnabled": {
      "type": "boolean",
      "description": "Indicates whether outdial campaign is enabled."
    },
    "queueRoutingType": {
      "type": "string",
      "description": "The queue routing type."
    },
    "callDistributionGroups": {
      "type": "array",
      "description": "The call distribution groups configured for this queue.",
      "items": {
        "$ref": "#/components/schemas/CallDistributionGroupBulkExportDTO"
      },
      "uniqueItems": true
    },
    "queueSkillRequirements": {
      "type": "array",
      "description": "The skill requirements configured for this queue.",
      "items": {
        "$ref": "#/components/schemas/QueueSkillRequirementDTO"
      },
      "uniqueItems": true
    },
    "agents": {
      "type": "array",
      "description": "The list of agent IDs assigned to this queue.",
      "items": {
        "type": "string"
      }
    },
    "manuallyAssignable": {
      "type": "boolean",
      "description": "Indicates whether the queue can be manually assigned."
    },
    "queueLevelSummariesInclusion": {
      "type": "string",
      "description": "Queue level summaries inclusion type.",
      "enum": [
        "NOT_APPLICABLE",
        "EXCLUDED",
        "INCLUDED"
      ]
    },
    "queueLevelSentimentAnalysisInclusion": {
      "type": "string",
      "description": "Queue level sentiment analysis inclusion type.",
      "enum": [
        "NOT_APPLICABLE",
        "EXCLUDED",
        "INCLUDED"
      ]
    },
    "queueLevelPredictedWaitTimeInclusion": {
      "type": "string",
      "description": "Queue level predicted wait time inclusion type.",
      "enum": [
        "NOT_APPLICABLE",
        "EXCLUDED",
        "INCLUDED"
      ]
    },
    "queueLevelAutoCsatInclusion": {
      "type": "string",
      "description": "Queue level auto CSAT inclusion type.",
      "enum": [
        "NOT_APPLICABLE",
        "EXCLUDED",
        "INCLUDED"
      ]
    },
    "queueLevelRealTimeTranscriptionsInclusion": {
      "type": "string",
      "description": "Queue level real time transcriptions inclusion type.",
      "enum": [
        "NOT_APPLICABLE",
        "EXCLUDED",
        "INCLUDED"
      ]
    },
    "assistantSkill": {
      "$ref": "#/components/schemas/AssistantSkillMappingDTO",
      "description": "The assistant skill mapping for this queue."
    }
  }
}