Webex · Schema

AgentWellbeingDTO

This is applicable/available only when AI Assistant add-on offer/license is added to the organization.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
enable	boolean	Used to toggle the state of the AI feature sub feature configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer sh
agentInclusionType	string	Provides information whether all or specific agents are selected for Agent Wellbeing. If the value is missing in response, the consumer should assume a value as ALL.
wellnessBreakReminders	string	Provides information whether Wellness break reminders are enabled or disabled. If the value is missing in response, the consumer should assume a value as DISABLED.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AgentWellbeingDTO",
  "title": "AgentWellbeingDTO",
  "type": "object",
  "description": "This is applicable/available only when AI Assistant add-on offer/license is added to the organization.",
  "properties": {
    "enable": {
      "type": "boolean",
      "description": "Used to toggle the state of the AI feature sub feature  configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false.",
      "example": true
    },
    "agentInclusionType": {
      "type": "string",
      "description": "Provides information whether all or specific agents are selected for Agent Wellbeing. If the value is missing in response, the consumer should assume a value as ALL.",
      "enum": [
        "ALL",
        "SPECIFIC"
      ],
      "example": "ALL"
    },
    "wellnessBreakReminders": {
      "type": "string",
      "description": "Provides information whether Wellness break reminders are enabled or disabled. If the value is missing in response, the consumer should assume a value as DISABLED.",
      "enum": [
        "DISABLED",
        "ENABLED"
      ],
      "example": "DISABLED"
    }
  },
  "required": [
    "agentInclusionType",
    "enable"
  ]
}