SequentialRingSettingsPut

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SequentialRingSettingsPut",
  "title": "SequentialRingSettingsPut",
  "type": "object",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": false,
      "description": "Enable or disable sequential ring for the user."
    },
    "ringBaseLocationFirstEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, the user's own devices ring before sequential ring numbers."
    },
    "baseLocationNumberOfRings": {
      "type": "integer",
      "example": 2,
      "description": "Number of rings for the user's own devices. Minimum: 2, Maximum: 20."
    },
    "continueIfBaseLocationIsBusyEnabled": {
      "type": "boolean",
      "example": false,
      "description": "When `true`, sequential ring continues even when the user is unavailable. It controls if we allow trying the sequential ring numbers when either a service for the user such as Do Not Disturb or Call Waiting sends the call to busy processing, or ringBaseLocationFirstEnabled is true but all the user's devices are unreachable."
    },
    "callsToVoicemailEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, the caller is provided the option to press the # key to end the sequential ring service and send the call to no answer handling such as voicemail."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SequentialRingNumber"
      },
      "description": "List of phone numbers to ring sequentially. Maximum 5 phone numbers."
    }
  }
}