Webex · Schema

GetCallQueueEssentialsObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the call queue.
name	string	Unique name for the call queue.
hasCxEssentials	boolean	Denotes if the call queue has Customer Assist license.
enabled	boolean	Whether or not the call queue is enabled.
language	string	Language for call queue.
languageCode	string	Language code for call queue.
firstName	string	First name to be shown when calls are forwarded out of this call queue. Defaults to ".".
lastName	string	Last name to be shown when calls are forwarded out of this call queue. Defaults to the phone number if set, otherwise defaults to call group name.
timeZone	string	Time zone for the call queue.
phoneNumber	string	Primary phone number of the call queue.
extension	string	Extension of the call queue.
alternateNumberSettings	object	The alternate numbers feature allows you to assign multiple phone numbers or extensions to a call queue. Each number will reach the same greeting and each menu will function identically to the main nu
callPolicies	object	Policy controlling how calls are routed to agents.
queueSettings	object	Overall call queue settings.
allowCallWaitingForAgentsEnabled	boolean	Flag to indicate whether call waiting is enabled for agents.
agents	array	People, including workspaces, that are eligible to receive calls.
department	object	The department information.
directLineCallerIdName	object	Settings for the direct line caller ID name to be shown for this call queue.
dialByName	string	The name to be used for dial by name functions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetCallQueueEssentialsObject",
  "title": "GetCallQueueEssentialsObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "hasCxEssentials",
    "enabled",
    "alternateNumberSettings",
    "callPolicies",
    "queueSettings",
    "agents"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx",
      "description": "A unique identifier for the call queue."
    },
    "name": {
      "type": "string",
      "example": "CallQueue-1",
      "description": "Unique name for the call queue."
    },
    "hasCxEssentials": {
      "type": "boolean",
      "example": true,
      "description": "Denotes if the call queue has Customer Assist license."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the call queue is enabled."
    },
    "language": {
      "type": "string",
      "example": "English",
      "description": "Language for call queue."
    },
    "languageCode": {
      "type": "string",
      "example": "en-US",
      "description": "Language code for call queue."
    },
    "firstName": {
      "type": "string",
      "example": "Hakim",
      "description": "First name to be shown when calls are forwarded out of this call queue. Defaults to \".\"."
    },
    "lastName": {
      "type": "string",
      "example": "Smith",
      "description": "Last name to be shown when calls are forwarded out of this call queue. Defaults to the phone number if set, otherwise defaults to call group name."
    },
    "timeZone": {
      "type": "string",
      "example": "America/Chicago",
      "description": "Time zone for the call queue."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+15558675309",
      "description": "Primary phone number of the call queue."
    },
    "extension": {
      "type": "string",
      "example": "7781",
      "description": "Extension of the call queue."
    },
    "alternateNumberSettings": {
      "type": "object",
      "required": [
        "distinctiveRingEnabled",
        "alternateNumbers"
      ],
      "properties": {
        "distinctiveRingEnabled": {
          "type": "boolean",
          "example": true,
          "description": "Distinctive Ringing selected for the alternate numbers in the call queue overrides the normal ringing patterns set for Alternate Number."
        },
        "alternateNumbers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/AlternateNumbersWithPattern"
          },
          "description": "Allows up to 10 numbers, each with an optional distinctive ring setting override."
        }
      },
      "description": "The alternate numbers feature allows you to assign multiple phone numbers or extensions to a call queue. Each number will reach the same greeting and each menu will function identically to the main number. The alternate numbers option enables you to have up to ten (10) phone numbers ring into the call queue."
    },
    "callPolicies": {
      "$ref": "#/components/schemas/GetCallQueueEssentialsCallPolicyObject",
      "description": "Policy controlling how calls are routed to agents."
    },
    "queueSettings": {
      "$ref": "#/components/schemas/CallQueueQueueEssentialsSettingsObject",
      "description": "Overall call queue settings."
    },
    "allowCallWaitingForAgentsEnabled": {
      "type": "boolean",
      "description": "Flag to indicate whether call waiting is enabled for agents."
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GetPersonPlaceObject"
      },
      "description": "People, including workspaces, that are eligible to receive calls."
    },
    "department": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ",
          "description": "Unique identifier of the department."
        },
        "name": {
          "type": "string",
          "example": "HR",
          "description": "Name of the department."
        }
      },
      "description": "The department information."
    },
    "directLineCallerIdName": {
      "$ref": "#/components/schemas/DirectLineCallerIdNameObject",
      "description": "Settings for the direct line caller ID name to be shown for this call queue."
    },
    "dialByName": {
      "type": "string",
      "example": "Hakim Smith",
      "description": "The name to be used for dial by name functions."
    }
  }
}