Webex · Schema

CallQueueGet

Details of a call queue that the agent has joined or may join.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique call queue identifier.
hasCxEssentials boolean Indicates if the call queue is `normal` or `CxEssentials`.
available boolean When `true` it indicates agent has joined the call center.
skillLevel number Call center skill level.
phoneNumber string Call center phone number.
extension string Call center extension.
allowLogOffEnabled boolean Determines whether a queue can be joined or not.
View JSON Schema on GitHub

JSON Schema

webex-callqueueget-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallQueueGet",
  "title": "CallQueueGet",
  "type": "object",
  "description": "Details of a call queue that the agent has joined or may join.",
  "example": {
    "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg",
    "hasCxEssentials": true,
    "available": true,
    "skillLevel": 1,
    "phoneNumber": "+18555550101",
    "extension": "50001",
    "allowLogOffEnabled": false
  },
  "required": [
    "id",
    "allowLogOffEnabled"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg",
      "description": "Unique call queue identifier."
    },
    "hasCxEssentials": {
      "type": "boolean",
      "example": true,
      "description": "Indicates if the call queue is `normal` or `CxEssentials`."
    },
    "available": {
      "type": "boolean",
      "example": true,
      "description": "When `true` it indicates agent has joined the call center."
    },
    "skillLevel": {
      "type": "number",
      "example": 1,
      "description": "Call center skill level."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+18555550101",
      "description": "Call center phone number."
    },
    "extension": {
      "type": "string",
      "example": "50001",
      "description": "Call center extension."
    },
    "allowLogOffEnabled": {
      "type": "boolean",
      "example": false,
      "description": "Determines whether a queue can be joined or not."
    }
  }
}