ModeManagementFeaturesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ModeManagementFeaturesResponse",
  "title": "ModeManagementFeaturesResponse",
  "type": "object",
  "required": [
    "features"
  ],
  "properties": {
    "features": {
      "type": "array",
      "description": "List of mode management features. Returns all items in a single response.",
      "example": [
        {
          "id": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
          "name": "Main Reception",
          "type": "AUTO_ATTENDANT",
          "modeBasedForwardingEnabled": true
        }
      ],
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "type",
          "modeBasedForwardingEnabled"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
            "description": "Unique identifier for the auto attendant, call queue, or hunt group."
          },
          "name": {
            "type": "string",
            "example": "Main Reception",
            "description": "Display name of the auto attendant, call queue, or hunt group."
          },
          "type": {
            "type": "string",
            "enum": [
              "AUTO_ATTENDANT",
              "CALL_QUEUE",
              "HUNT_GROUP"
            ],
            "example": "AUTO_ATTENDANT",
            "description": " * `AUTO_ATTENDANT` - Auto Attendant feature.\n * `CALL_QUEUE` - Call Queue feature (includes customer assist queues).\n * `HUNT_GROUP` - Hunt Group feature.\n"
          },
          "phoneNumber": {
            "type": "string",
            "example": "+14085551234",
            "description": "Phone number of the feature"
          },
          "extension": {
            "type": "string",
            "example": "1234",
            "description": "Extension of the feature"
          },
          "modeBasedForwardingEnabled": {
            "type": "boolean",
            "example": true,
            "description": "Whether mode based forwarding is enabled for the feature"
          },
          "location": {
            "type": "object",
            "description": "Location information for the feature",
            "required": [
              "id",
              "name"
            ],
            "properties": {
              "id": {
                "type": "string",
                "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1Njc4LTkwYWItY2RlZi0xMjM0LTU2Nzg5MGFiY2RlZg==",
                "description": "Unique identifier for the location."
              },
              "name": {
                "type": "string",
                "example": "San Jose Office",
                "description": "Display name of the location."
              }
            }
          },
          "forwardDestination": {
            "type": "string",
            "example": "+14085555678",
            "description": "Current forward destination"
          },
          "currentOperatingModeName": {
            "type": "string",
            "example": "Business Hours",
            "description": "Name of the current operating mode"
          },
          "currentOperatingModeId": {
            "type": "string",
            "example": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzAyZjZlMmI4LTFjZDktNWI3ZS1jOTVjLTczYzZkYzk1MTZjMg==",
            "description": "ID of the current operating mode"
          },
          "exceptionType": {
            "type": "string",
            "enum": [
              "AUTOMATIC_SWITCH_BACK_EARLY_START",
              "AUTOMATIC_SWITCH_BACK_EXTENSION",
              "MANUAL_SWITCH_BACK",
              "AUTOMATIC_SWITCH_BACK_STANDARD"
            ],
            "example": "MANUAL_SWITCH_BACK",
            "description": "Type of exception indicating how the feature will switch back from the current mode. This field is not present when the feature is in normal operation.\n\n * `AUTOMATIC_SWITCH_BACK_EARLY_START` - Automatic switchback with early start.\n * `AUTOMATIC_SWITCH_BACK_EXTENSION` - Automatic switchback with extension.\n * `MANUAL_SWITCH_BACK` - Manual switchback required.\n * `AUTOMATIC_SWITCH_BACK_STANDARD` - Standard automatic switchback.\n"
          }
        }
      }
    }
  },
  "example": {
    "features": [
      {
        "id": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
        "name": "Main Reception",
        "type": "AUTO_ATTENDANT",
        "phoneNumber": "+14085551234",
        "extension": "1234",
        "modeBasedForwardingEnabled": true,
        "location": {
          "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1Njc4LTkwYWItY2RlZi0xMjM0LTU2Nzg5MGFiY2RlZg==",
          "name": "San Jose Office"
        },
        "forwardDestination": "+14085555678",
        "currentOperatingModeName": "Business Hours",
        "currentOperatingModeId": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzAyZjZlMmI4LTFjZDktNWI3ZS1jOTVjLTczYzZkYzk1MTZjMg==",
        "exceptionType": "MANUAL_SWITCH_BACK"
      }
    ]
  }
}