Webex · Schema

GetPagingGroupAgentObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Agents ID.
firstName	string	Agent's first name. Minimum length is 1. Maximum length is 64.
lastName	string	Agent's last name. Minimum length is 1. Maximum length is 64.
type	string	Type of the person, workspace or virtual line. * `PEOPLE` - Indicates that this object is a person. * `PLACE` - Indicates that this object is a workspace, formerly known as a place. * `VIRTUAL_LINE` -
phoneNumber	string	Agent's phone number. Minimum length is 1. Maximum length is 23. Either `phoneNumber` or `extension` is mandatory.
extension	string	Agent's extension. Minimum length is 2. Maximum length is 10. Either `phoneNumber` or `extension` is mandatory.
routingPrefix	string	Routing prefix of location.
esn	string	Routing prefix + extension of a person or workspace.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetPagingGroupAgentObject",
  "title": "GetPagingGroupAgentObject",
  "type": "object",
  "required": [
    "id",
    "firstName",
    "lastName",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI",
      "description": "Agents ID."
    },
    "firstName": {
      "type": "string",
      "example": "John",
      "description": "Agent's first name. Minimum length is 1. Maximum length is 64."
    },
    "lastName": {
      "type": "string",
      "example": "Doe",
      "description": "Agent's last name. Minimum length is 1. Maximum length is 64."
    },
    "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 person.\n * `PLACE` - Indicates that this object is a workspace, formerly known as a place.\n * `VIRTUAL_LINE` - Indicates that this object is a virtual line.\n"
    },
    "phoneNumber": {
      "type": "string",
      "example": "+15558675309",
      "description": "Agent's phone number. Minimum length is 1. Maximum length is 23.  Either `phoneNumber` or `extension` is mandatory."
    },
    "extension": {
      "type": "string",
      "example": "7781",
      "description": "Agent's extension. Minimum length is 2. Maximum length is 10.  Either `phoneNumber` or `extension` is mandatory."
    },
    "routingPrefix": {
      "type": "string",
      "example": "1234",
      "description": "Routing prefix of location."
    },
    "esn": {
      "type": "string",
      "example": "12347781",
      "description": "Routing prefix + extension of a person or workspace."
    }
  }
}