{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/PatchCallQueueNightServiceObject", "title": "PatchCallQueueNightServiceObject", "type": "object", "required": [ "nightServiceEnabled", "playAnnouncementBeforeEnabled", "announcementMode", "audioMessageSelection", "forceNightServiceEnabled", "manualAudioMessageSelection" ], "properties": { "nightServiceEnabled": { "type": "boolean", "example": true, "description": "Enable or disable call queue night service routing policy." }, "action": { "type": "string", "enum": [ "BUSY", "TRANSFER" ], "description": "The call processing action type.\n * `BUSY` - The caller hears a fast busy tone.\n * `TRANSFER` - Transfers the call to number specified in `transferPhoneNumber`.\n" }, "transferPhoneNumber": { "type": "string", "example": "1234", "description": "Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension." }, "playAnnouncementBeforeEnabled": { "type": "boolean", "example": true, "description": "Indicates whether an announcement plays to callers before the action is applied." }, "announcementMode": { "type": "string", "enum": [ "NORMAL", "MANUAL" ], "description": "The type of announcements to played.\n * `NORMAL` - Plays announcement as per `audioMessageSelection`.\n * `MANUAL` - Plays announcement as per `manualAudioMessageSelection`.\n" }, "audioMessageSelection": { "type": "string", "enum": [ "DEFAULT", "CUSTOM" ], "description": "The type of announcements to be played when announcementMode is set to `NORMAL`.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" }, "audioFiles": { "type": "array", "items": { "$ref": "#/components/schemas/AudioAnnouncementFileFeatureObject" }, "description": "List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`." }, "businessHoursName": { "type": "string", "example": "Working Hour", "description": "Name of the schedule configured for a night service as one of from `businessHourSchedules` list." }, "businessHoursLevel": { "type": "string", "enum": [ "ORGANIZATION", "LOCATION" ], "description": "The above mentioned schedule is org or location specific. (Must be from `businessHourSchedules` list)\n * `ORGANIZATION` - Schedule is configured across an organization.\n * `LOCATION` - Schedule is configured across a location.\n" }, "forceNightServiceEnabled": { "type": "boolean", "example": true, "description": "Force night service regardless of business hour schedule." }, "manualAudioMessageSelection": { "type": "string", "enum": [ "DEFAULT", "CUSTOM" ], "description": "The type of announcements to be played when announcementMode is set to `MANUAL`.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" }, "manualAudioFiles": { "type": "array", "items": { "$ref": "#/components/schemas/AudioAnnouncementFileFeatureObject" }, "description": "List Of pre-configured Audio Files." } } }