PostAutoAttendantObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostAutoAttendantObject",
  "title": "PostAutoAttendantObject",
  "type": "object",
  "required": [
    "name",
    "businessSchedule",
    "businessHoursMenu",
    "afterHoursMenu"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Main Line IA - Test",
      "description": "Unique name for the auto attendant."
    },
    "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."
    },
    "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."
    },
    "languageCode": {
      "type": "string",
      "example": "en_us",
      "description": "Announcement 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/PostHoursMenuObject",
      "description": "Business hours menu defined for the auto attendant."
    },
    "afterHoursMenu": {
      "$ref": "#/components/schemas/PostHoursMenuObject",
      "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. Characters of `%`,  `+`, `\\`, `\"` and Unicode characters are not allowed."
    }
  }
}