Webex · Schema

CallMonitoringRequest

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	The id represents the unique request id with which the Monitoring Request will be created, maximum length 36 characters.
monitorType	string	It represents the type of the monitoring request. It can to be ```midcall```, ```adhoc``` and ```continuous```
taskId	string	The unique ID representing the task that needs to be monitored. Mandatory for ```midcall``` type.
queueIds	array	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 ea
teams	array	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
sites	array	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
agents	array	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	string	An unique id to keep a track of events occurring during the call
invisibleMode	boolean	This allows the supervisor to obfuscate their details from Team Performance Widget panel. Set ```true``` inorder to activate this mode

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallMonitoringRequest",
  "title": "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.",
      "example": "3b7e6ad3-e5fe-4dd1-89a1-d7d952e29990"
    },
    "monitorType": {
      "type": "string",
      "description": " It represents the type of the monitoring request. It can to be ```midcall```, ```adhoc``` and ```continuous```",
      "example": "midcall"
    },
    "taskId": {
      "type": "string",
      "format": "UUID",
      "description": "The unique ID representing the task that needs to be monitored. Mandatory for ```midcall``` type.",
      "example": "9ce62805-3931-44d3-a839-3004025f7e30"
    },
    "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.",
      "example": "[fbed39e1-4ed8-4179-828b-075e3788649c]"
    },
    "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.",
      "example": "[510d198d-7aa7-4b75-a5ff-e61759f4f313]"
    },
    "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.",
      "example": "[67c5b4c8-9c78-4400-8148-8254dc550c49]"
    },
    "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.",
      "example": "[fbed39e1-4ed8-4179-828b-075e3788649c]"
    },
    "trackingId": {
      "type": "string",
      "format": "UUID",
      "description": "An unique id to keep a track of events occurring during the call",
      "example": "8bd52805-3931-44d3-a839-3004025f7e30"
    },
    "invisibleMode": {
      "type": "boolean",
      "description": "This allows the supervisor to obfuscate their details from Team Performance Widget panel. Set ```true``` inorder to activate this mode",
      "example": "false"
    }
  }
}