Webex · Schema

MonitoringSettingsGetResponseObject

Response object containing the monitoring settings for the logged in person.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
callParkNotificationEnabled boolean Call park notification is enabled or disabled. Only applies to monitored users, workspaces, and virtual lines. Does not apply to call park extensions.
monitoredElements array Settings of monitored elements which can be person, place, virtual line or call park extension.
View JSON Schema on GitHub

JSON Schema

webex-monitoringsettingsgetresponseobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MonitoringSettingsGetResponseObject",
  "title": "MonitoringSettingsGetResponseObject",
  "type": "object",
  "description": "Response object containing the monitoring settings for the logged in person.",
  "example": {
    "callParkNotificationEnabled": true,
    "monitoredElements": [
      {
        "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg",
        "lastName": "Nelson",
        "firstName": "John",
        "displayName": "John Nelson",
        "type": "PEOPLE",
        "email": "[email protected]",
        "extension": "50003",
        "esn": "50003",
        "locationName": "San Francisco",
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg"
      },
      {
        "id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2",
        "displayName": "Dallas-Test",
        "type": "CALL_PARK_EXTENSION",
        "extension": "10082",
        "locationName": "San Francisco",
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg"
      },
      {
        "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9mZTg5NmVmMC1iYTk3LTQ3NGYtOTMwZS03ODQxYzUwMjFhNDU=",
        "displayName": "TXS16 ConfRoom1",
        "type": "PLACE",
        "email": "[email protected]",
        "directNumber": "+15594015485",
        "locationName": "San Francisco",
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg"
      }
    ]
  },
  "required": [
    "callParkNotificationEnabled",
    "monitoredElements"
  ],
  "properties": {
    "callParkNotificationEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Call park notification is enabled or disabled. Only applies to monitored users, workspaces, and virtual lines. Does not apply to call park extensions."
    },
    "monitoredElements": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MonitoredElementItem"
      },
      "description": "Settings of monitored elements which can be person, place, virtual line or call park extension."
    }
  }
}