GetVoicemailRulesObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetVoicemailRulesObject",
  "title": "GetVoicemailRulesObject",
  "type": "object",
  "properties": {
    "defaultVoicemailPinRules": {
      "type": "object",
      "properties": {
        "blockRepeatedPatternsEnabled": {
          "type": "boolean",
          "example": true,
          "description": "If enabled, the passcode cannot contain repeated patterns. For example, 121212 and 123123."
        },
        "blockRepeatedDigits": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "example": true,
              "description": "If enabled, checks for sequence of the same digit being repeated."
            },
            "max": {
              "type": "number",
              "example": 3,
              "description": "Maximum number of repeated digit sequence allowed. The minimum value is 1. The maximum value is 6."
            }
          },
          "description": "Settings to prevent single digits from being repeated in the passcode. For example, with a maximum value of 3, 111222 is allowed but 112222 is not allowed since it contains a repeated digit sequence longer than 3."
        },
        "blockContiguousSequences": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "example": true,
              "description": "If enabled, passcode should not contain a numerical sequence."
            },
            "numberOfAscendingDigits": {
              "type": "number",
              "example": 3,
              "description": "Specifies the maximum length of an ascending numerical sequence allowed. The minimum value is 2. The maximum value is 5. Example: If this value is set to 3, then 123856 is allowed, but 123485 is not allowed (since the ascending sequence 1234 exceeds 3 digits)."
            },
            "numberOfDescendingDigits": {
              "type": "number",
              "example": 3,
              "description": "Specifies the maximum length of a descending numerical sequence allowed. The minimum value is 2. The maximum value is 5. Example: If this value is set to 3, then 321856 is allowed, but 432185 is not allowed (since the descending sequence 4321 exceeds 3 digits)."
            }
          },
          "description": "Settings for not allowing numerical sequence in passcode (for example, 012345 or 987654)."
        },
        "length": {
          "type": "object",
          "properties": {
            "min": {
              "type": "number",
              "example": 6,
              "description": "The minimum value is 2. The maximum value is 15."
            },
            "max": {
              "type": "number",
              "example": 30,
              "description": "The minimum value is 3. The maximum value is 30."
            }
          },
          "description": "Length of the passcode."
        },
        "defaultVoicemailPinEnabled": {
          "type": "boolean",
          "example": true,
          "description": "If enabled, the default voicemail passcode can be set."
        }
      },
      "description": "Default voicemail passcode requirements."
    },
    "expirePasscode": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "If enabled, passcode expires after the number of days specified."
        },
        "numberOfDays": {
          "type": "number",
          "example": 180,
          "description": "Number of days for password expiry. The minimum value is 15. The maximum value is 180."
        }
      },
      "description": "Settings for passcode expiry."
    },
    "changePasscode": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "If enabled, set minimum number of days between passcode changes."
        },
        "numberOfDays": {
          "type": "number",
          "example": 180,
          "description": "Number of days between passcode changes. The minimum value is 1. The maximum value is 7."
        }
      },
      "description": "Settings for passcode changes."
    },
    "blockPreviousPasscodes": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "If enabled, set how many of the previous passcodes are not allowed to be re-used."
        },
        "numberOfPasscodes": {
          "type": "number",
          "example": 10,
          "description": "Number of previous passcodes. The minimum value is 1. The maximum value is 10."
        }
      },
      "description": "Settings for previous passcode usage."
    }
  }
}