SelectiveCallForwardCriteriaPatch

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SelectiveCallForwardCriteriaPatch",
  "title": "SelectiveCallForwardCriteriaPatch",
  "type": "object",
  "example": {
    "forwardToPhoneNumber": "+16175550100",
    "destinationVoicemailEnabled": false,
    "scheduleName": "Holiday V2",
    "scheduleType": "businessHours",
    "scheduleLevel": "PEOPLE",
    "callsFrom": "SELECT_PHONE_NUMBERS",
    "phoneNumbers": [
      "+16177817766"
    ],
    "anonymousCallersEnabled": true,
    "unavailableCallersEnabled": false,
    "forwardEnabled": true
  },
  "description": "Request body for updating selective call forwarding criteria settings.",
  "properties": {
    "forwardToPhoneNumber": {
      "type": "string",
      "description": "The phone number to which calls are forwarded when the criteria conditions are met.",
      "example": "+16175550100"
    },
    "destinationVoicemailEnabled": {
      "type": "boolean",
      "description": "Indicates whether calls that meet the criteria are forwarded to the destination phone number's voicemail.",
      "example": false
    },
    "scheduleName": {
      "type": "string",
      "description": "Name of the schedule to be associated with the criteria.",
      "example": "Holiday V2"
    },
    "scheduleType": {
      "type": "string",
      "enum": [
        "businessHours",
        "holidays"
      ],
      "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
    },
    "scheduleLevel": {
      "type": "string",
      "enum": [
        "PEOPLE",
        "LOCATION"
      ],
      "description": " * `PEOPLE` - The schedule is at the user level.\n * `LOCATION` - The schedule is at the location level.\n"
    },
    "callsFrom": {
      "type": "string",
      "enum": [
        "ANY_PHONE_NUMBER",
        "SELECT_PHONE_NUMBERS",
        "ANY_INTERNAL",
        "ANY_EXTERNAL"
      ],
      "description": "Specifies the type of callsFrom, categorizing incoming data based on callsFrom types or numbers that match the current criteria.\n * `ANY_PHONE_NUMBER` - The criteria applies to any phone number.\n* `SELECT_PHONE_NUMBERS` - The criteria applies to selected phone numbers.\n* `ANY_INTERNAL` - The criteria applies to any internal number.\n* `ANY_EXTERNAL` - The criteria applies to any external number.\n"
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "description": "Indicates whether anonymous callers are included in this criteria. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.",
      "example": true
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "description": "Indicates whether unavailable callers are included in this criteria. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.",
      "example": true
    },
    "phoneNumbers": {
      "type": "array",
      "description": "List of phone numbers to update for this criteria. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.",
      "items": {
        "type": "string",
        "description": "Phone number that the criteria applies to."
      }
    },
    "forwardEnabled": {
      "type": "boolean",
      "description": "Determines whether selective call forwarding is applied for calls matching this criteria. If `true`, the selective forwarding is applied. If `false`, this criteria acts as a 'Don't Forward' rule, preventing selectively forwarding of the calls. Criteria with `forwardEnabled` set to `false` (Don't Forward) take precedence over criteria with `forwardEnabled` set to `true` (Forward).",
      "example": false
    }
  }
}