{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/GetAutoAttendantObject", "title": "GetAutoAttendantObject", "type": "object", "required": [ "id", "name", "enabled", "tollFreeNumber", "firstName", "lastName", "businessSchedule", "extensionDialing", "nameDialing", "businessHoursMenu", "afterHoursMenu" ], "properties": { "id": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw", "description": "A unique identifier for the auto attendant." }, "name": { "type": "string", "example": "Main Line AA - Test", "description": "Unique name for the auto attendant." }, "enabled": { "type": "boolean", "example": true, "description": "Flag to indicate if auto attendant number is enabled or not." }, "phoneNumber": { "type": "string", "example": "+19705550028", "description": "Auto attendant phone number. Either `phoneNumber` or `extension` is mandatory." }, "extension": { "type": "string", "example": "1001", "description": "Auto attendant extension. Either `phoneNumber` or `extension` is mandatory." }, "routingPrefix": { "type": "string", "example": "1234", "description": "Routing prefix of location." }, "esn": { "type": "string", "example": "12341001", "description": "Routing prefix + extension of a person or workspace." }, "tollFreeNumber": { "type": "boolean", "description": "Flag to indicate if auto attendant number is toll-free number." }, "firstName": { "type": "string", "example": "Main Line AA", "description": "First name defined for an auto attendant. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead." }, "lastName": { "type": "string", "example": "Test", "description": "Last name defined for an auto attendant. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead." }, "alternateNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/AlternateNumbersObject" }, "description": "Alternate numbers defined for the auto attendant." }, "language": { "type": "string", "example": "English", "description": "Language for the auto attendant." }, "languageCode": { "type": "string", "example": "en_us", "description": "Language code for the auto attendant." }, "businessSchedule": { "type": "string", "example": "AUTOATTENDANT-BUSINESS-HOURS", "description": "Business hours defined for the auto attendant." }, "holidaySchedule": { "type": "string", "example": "AUTOATTENDANT-HOLIDAY", "description": "Holiday defined for the auto attendant." }, "extensionDialing": { "type": "string", "enum": [ "ENTERPRISE", "GROUP" ], "description": "Extension dialing setting. If the values are not set default will be set as `ENTERPRISE`." }, "nameDialing": { "type": "string", "enum": [ "ENTERPRISE", "GROUP" ], "description": "Name dialing setting. If the values are not set default will be set as `ENTERPRISE`." }, "timeZone": { "type": "string", "example": "America/Los_Angeles", "description": "Time zone defined for the auto attendant." }, "businessHoursMenu": { "$ref": "#/components/schemas/HoursMenuGetObject", "description": "Business hours menu defined for the auto attendant." }, "afterHoursMenu": { "$ref": "#/components/schemas/HoursMenuGetObject", "description": "After hours menu defined for the auto attendant." }, "directLineCallerIdName": { "$ref": "#/components/schemas/DirectLineCallerIdNameObject", "description": "Settings for the direct line caller ID name to be shown for this auto attendant." }, "dialByName": { "type": "string", "example": "Hakim Smith", "description": "The name to be used for dial by name functions." } } }