Webex · Schema

GetPersonPlaceVirtualLineCallQueueObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	ID of person, workspace or virtual line.
type	string	Type of the person, workspace or virtual line. * `PEOPLE` - Indicates that this object is a user. * `PLACE` - Indicates that this object is a place. * `VIRTUAL_LINE` - Indicates that this object is a
firstName	string	First name of person, workspace or virtual line.
lastName	string	First name of person, workspace or virtual line.
phoneNumber	string	Phone number of person, workspace or virtual line.
extension	string	Extension of person, workspace or virtual line.
weight	string	Weight of person, workspace or virtual line. Only applied when call policy is `WEIGHTED`.
skillLevel	number	Skill level of person, workspace or virtual line. Only applied when the call `routingType` is `SKILL_BASED`.
joinEnabled	boolean	Indicates the join status of the agent for this queue. The default value while creating call queue is `true`.
location	object	Location of the call queue.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetPersonPlaceVirtualLineCallQueueObject",
  "title": "GetPersonPlaceVirtualLineCallQueueObject",
  "type": "object",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE1NmE",
      "description": "ID of person, workspace or virtual line."
    },
    "type": {
      "type": "string",
      "enum": [
        "PEOPLE",
        "PLACE",
        "VIRTUAL_LINE"
      ],
      "description": "Type of the person, workspace or virtual line.\n * `PEOPLE` - Indicates that this object is a user.\n * `PLACE` - Indicates that this object is a place.\n * `VIRTUAL_LINE` - Indicates that this object is a virtual line.\n"
    },
    "firstName": {
      "type": "string",
      "example": "Hakim",
      "description": "First name of person, workspace or virtual line."
    },
    "lastName": {
      "type": "string",
      "example": "Smith",
      "description": "First name of person, workspace or virtual line."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+12225555309",
      "description": "Phone number of person, workspace or virtual line."
    },
    "extension": {
      "type": "string",
      "example": "5309",
      "description": "Extension of person, workspace or virtual line."
    },
    "weight": {
      "type": "string",
      "example": "50",
      "description": "Weight of person, workspace or virtual line. Only applied when call policy is `WEIGHTED`."
    },
    "skillLevel": {
      "type": "number",
      "example": 1,
      "description": "Skill level of person, workspace or virtual line. Only applied when the call `routingType` is `SKILL_BASED`."
    },
    "joinEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates the join status of the agent for this queue. The default value while creating call queue is `true`."
    },
    "location": {
      "$ref": "#/components/schemas/LocationObject",
      "description": "Location of the call queue."
    }
  }
}