Webex · Schema

GetMonitoredElementsObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
member object
callparkextension object
View JSON Schema on GitHub

JSON Schema

webex-getmonitoredelementsobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetMonitoredElementsObject",
  "title": "GetMonitoredElementsObject",
  "type": "object",
  "properties": {
    "member": {
      "type": "object",
      "required": [
        "id",
        "lastName",
        "firstName",
        "displayName",
        "numbers",
        "location",
        "locationId"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OWNlZjRmYS03YTM5LTQ1ZDItOTNmNi1jNjA5YTRiMjgzODY",
          "description": "The identifier of the monitored person, workspace or virtual line."
        },
        "lastName": {
          "type": "string",
          "example": "Nelson",
          "description": "The last name of the monitored person, workspace or virtual line."
        },
        "firstName": {
          "type": "string",
          "example": "John",
          "description": "The first name of the monitored person, workspace or virtual line."
        },
        "displayName": {
          "type": "string",
          "example": "John Nelson",
          "description": "The display name of the monitored person, workspace or virtual line."
        },
        "type": {
          "$ref": "#/components/schemas/PeopleOrPlaceOrVirtualLineType",
          "description": "Indicates whether the type is `PEOPLE`, `PLACE` or `VIRTUAL_LINE`."
        },
        "email": {
          "type": "string",
          "example": "[email protected]",
          "description": "The email address of the monitored person."
        },
        "numbers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/MonitoredNumberObject"
          },
          "description": "The list of phone numbers containing only the primary number for the monitored person, workspace, or virtual line."
        },
        "location": {
          "type": "string",
          "example": "Dallas",
          "description": "The name of the location where the monitored person, workspace, or virtual line is situated."
        },
        "locationId": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw",
          "description": "The ID for the location."
        }
      }
    },
    "callparkextension": {
      "type": "object",
      "required": [
        "id",
        "location",
        "locationId"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vZTdlZDdiMDEtN2E4Ni00NDEwLWFlODMtOWJmODMzZGEzNzQy",
          "description": "The identifier of the call park extension."
        },
        "name": {
          "type": "string",
          "example": "Dallas-Test",
          "description": "The name used to describe the call park extension."
        },
        "extension": {
          "type": "string",
          "example": "4001",
          "description": "The extension number for the call park extension."
        },
        "routingPrefix": {
          "type": "string",
          "example": "1234",
          "description": "Routing prefix of location."
        },
        "esn": {
          "type": "string",
          "example": "12344001",
          "description": "Routing prefix + extension of the call park extension."
        },
        "location": {
          "type": "string",
          "example": "Dallas",
          "description": "The location name where the call park extension is."
        },
        "locationId": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw",
          "description": "The ID for the location."
        }
      }
    }
  }
}