Webex · Schema

UserModeManagementFeatureObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the feature.
name	string	Unique name for the feature.
type	object	Defines the scheduling of the operating mode.
phoneNumber	string	The primary phone number configured for the feature.
extension	string	The extension configured for the feature.
modeBasedForwardingEnabled	boolean	A flag to indicate whether mode-based call forwarding is enabled for the feature.
forwardDestination	string	The destination for call forwarding if mode-based call forwarding is enabled.
currentOperatingModeName	string	Name of the current operating mode.
currentOperatingModeId	string	Unique identifier for the current operating mode.
exceptionType	object	Defines the exception through which the current operating mode is set as active for the feature.
location	object	Location object that has a unique identifier for the location and its name.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserModeManagementFeatureObject",
  "title": "UserModeManagementFeatureObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "type",
    "modeBasedForwardingEnabled",
    "exceptionType"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ",
      "description": "A unique identifier for the feature."
    },
    "name": {
      "type": "string",
      "example": "Test Feature",
      "description": "Unique name for the feature."
    },
    "type": {
      "$ref": "#/components/schemas/ModeManagementFeatureTypeObject",
      "description": "Defines the scheduling of the operating mode."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+19705550028",
      "description": "The primary phone number configured for the feature."
    },
    "extension": {
      "type": "string",
      "example": "0028",
      "description": "The extension configured for the feature."
    },
    "modeBasedForwardingEnabled": {
      "type": "boolean",
      "example": true,
      "description": "A flag to indicate whether mode-based call forwarding is enabled for the feature."
    },
    "forwardDestination": {
      "type": "string",
      "example": "+19705550028",
      "description": "The destination for call forwarding if mode-based call forwarding is enabled."
    },
    "currentOperatingModeName": {
      "type": "string",
      "example": "Day Operating Mode",
      "description": "Name of the current operating mode."
    },
    "currentOperatingModeId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzIxM2I1ZTIwLTljMjAtNDUwNi1iYWE3LTE0OGE0NWQyZWY4OQ",
      "description": "Unique identifier for the current operating mode."
    },
    "exceptionType": {
      "$ref": "#/components/schemas/ExceptionTypeObject",
      "description": "Defines the exception through which the current operating mode is set as active for the feature."
    },
    "location": {
      "$ref": "#/components/schemas/location",
      "description": "Location object that has a unique identifier for the location and its name."
    }
  }
}