{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/SequentialRingSettingsGet", "title": "SequentialRingSettingsGet", "type": "object", "required": [ "enabled" ], "example": { "enabled": true, "ringBaseLocationFirstEnabled": false, "baseLocationNumberOfRings": 3, "continueIfBaseLocationIsBusyEnabled": true, "callsToVoicemailEnabled": false, "phoneNumbers": [ { "phoneNumber": "+19075552859", "answerConfirmationRequiredEnabled": false, "numberOfRings": 3 } ], "criteria": [ { "id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "scheduleName": "BusinessHours", "source": "ALL_NUMBERS", "ringEnabled": true } ] }, "properties": { "enabled": { "type": "boolean", "example": true, "description": "`true` if the sequential ring feature is enabled." }, "ringBaseLocationFirstEnabled": { "type": "boolean", "example": false, "description": "When `true`, the user's own devices ring before sequential ring numbers." }, "baseLocationNumberOfRings": { "type": "integer", "example": 3, "description": "Number of rings for the user's own devices. Minimum: 2, Maximum: 20." }, "continueIfBaseLocationIsBusyEnabled": { "type": "boolean", "example": true, "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." }, "criteria": { "type": "array", "items": { "$ref": "#/components/schemas/SequentialRingCriteriaSummary" }, "description": "List of criteria specifying conditions when sequential ring is in effect." } } }