{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-call-monitoring-request-schema.json",
  "title": "CallMonitoringRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-call-monitoring-api-openapi.yml#/components/schemas/CallMonitoringRequest",
  "required": [
    "id",
    "monitorType"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The id represents the unique request id with which the Monitoring Request will be created, maximum length 36 characters."
    },
    "monitorType": {
      "type": "string",
      "description": " It represents the type of the monitoring request. It can to be ```midcall```, ```adhoc``` and ```continuous```"
    },
    "taskId": {
      "type": "string",
      "format": "UUID",
      "description": "The unique ID representing the task that needs to be monitored. Mandatory for ```midcall``` type."
    },
    "queueIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If the call is routed to an agent and the agent is assigned to a queue, the queueId can be entered here to initiate a successful call monitoring request for that particular queue, maximum length of each queue is 36 characters and maximum number of queueIds 250."
    },
    "teams": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If the call is routed to an agent and the agent is assigned to a team, the teamId can be entered here to initiate a successful monitoring request for that particular team, maximum length of each team is 36 characters and maximum number of teams 100."
    },
    "sites": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If the call is routed to an agent and the agent is assigned to a site, the siteId can be entered here to initiate a successful monitoring request for that particular site, maximum length of each site is 36 characters and the maximum number of sites 20."
    },
    "agents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Enter the agentId to monitor a particular agent to whom the call is being assigned, maximum length of each agent is 36 characters and the maximum number of agents is 500."
    },
    "trackingId": {
      "type": "string",
      "format": "UUID",
      "description": "An unique id to keep a track of events occurring during the call"
    },
    "invisibleMode": {
      "type": "boolean",
      "description": "This allows the supervisor to obfuscate their details from Team Performance Widget panel. Set ```true``` inorder to activate this mode"
    }
  }
}