SimultaneousRingGet

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-simultaneous-ring-get-schema.json",
  "title": "SimultaneousRingGet",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-call-settings-for-me-phase-4-api-openapi.yml#/components/schemas/SimultaneousRingGet",
  "type": "object",
  "required": [
    "enabled",
    "doNotRingIfOnCallEnabled",
    "criteriasEnabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Simultaneous Ring is enabled or not."
    },
    "doNotRingIfOnCallEnabled": {
      "type": "boolean",
      "description": "When set to `true`, the configured phone numbers won't ring when on a call."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SimultaneousRingNumberGet"
      },
      "description": "Enter up to 10 phone numbers to ring simultaneously when a workspace phone receives an incoming call."
    },
    "criteria": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SimultaneousRingCriteria"
      },
      "description": "A list of criteria specifying conditions when simultaneous ring is in effect."
    },
    "criteriasEnabled": {
      "type": "boolean",
      "description": "When `true`, enables the selected schedule for simultaneous ring."
    }
  },
  "$defs": {
    "SimultaneousRingCriteria": {
      "type": "object",
      "required": [
        "id",
        "source",
        "ringEnabled"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for criteria."
        },
        "scheduleName": {
          "type": "string",
          "description": "Name of the location's schedule which determines when the simultaneous ring is in effect."
        },
        "source": {
          "$ref": "#/$defs/Source",
          "description": "If criteria are applicable for calls from any phone number or specific phone number."
        },
        "ringEnabled": {
          "type": "boolean",
          "description": "When set to `true` simultaneous ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority."
        }
      }
    },
    "SimultaneousRingNumberGet": {
      "type": "object",
      "required": [
        "phoneNumber",
        "answerConfirmationRequiredEnabled"
      ],
      "properties": {
        "phoneNumber": {
          "type": "string",
          "description": "Phone number set as the sequential number."
        },
        "answerConfirmationRequiredEnabled": {
          "type": "boolean",
          "description": "When set to `true` the called party is required to press 1 on the keypad to receive the call."
        }
      }
    },
    "Source": {
      "type": "string",
      "enum": [
        "ALL_NUMBERS",
        "SPECIFIC_NUMBERS"
      ],
      "description": " * `ALL_NUMBERS` - Criteria applies to all incoming numbers.\n * `SPECIFIC_NUMBERS` - Criteria applies only for specific incoming numbers.\n"
    }
  }
}