Webex Features: Auto Attendant API

openapi: 3.0.0
info:
  title: 'Webex Admin Address Book Features:  Auto Attendant API'
  version: 1.0.0
  description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: 'Features:  Auto Attendant'
paths:
  /telephony/config/autoAttendants:
    get:
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                required:
                - autoAttendants
                properties:
                  autoAttendants:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListAutoAttendantObject'
                    description: Array of auto attendants.
              example:
                autoAttendants:
                - id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                  name: Main Line AA - Test
                  locationName: Alaska
                  locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzI0NDY5OA
                  phoneNumber: '+19705550028'
                  extension: 0028
                  routingPrefix: '1234'
                  esn: '12340028'
                  tollFreeNumber: false
                - id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2NXZHVjWGg1WkhCbmFVQm1iR1Y0TWk1amFYTmpieTVqYjIw
                  name: AUTOATTENDANT-TEST 1
                  locationName: Alaska
                  locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzI0NDY5OA
                  phoneNumber: '+19705550030'
                  extension: '1234'
                  routingPrefix: '1234'
                  esn: '12340028'
                  tollFreeNumber: false
                - id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw
                  name: AUTOATTENDANT-TEST 2
                  locationName: Houston
                  locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzI2NDE1MA
                  phoneNumber: '+17135551001'
                  extension: '1001'
                  routingPrefix: '1234'
                  esn: '12340028'
                  tollFreeNumber: false
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Read the List of Auto Attendants
      operationId: listAutoAttendants
      description: 'List all Auto Attendants for the organization.


        Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.


        Retrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
      tags:
      - 'Features:  Auto Attendant'
      parameters:
      - name: orgId
        in: query
        description: List auto attendants for this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
      - name: locationId
        in: query
        description: Return the list of auto attendants for this location.
        example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
        schema:
          type: string
      - name: max
        in: query
        description: Limit the number of objects returned to this maximum count.
        example: '5'
        schema:
          type: number
      - name: start
        in: query
        description: Start at the zero-based offset in the list of matching objects.
        example: '0'
        schema:
          type: number
      - name: name
        in: query
        description: Only return auto attendants with the matching name.
        example: Main Line AA - Test
        schema:
          type: string
      - name: phoneNumber
        in: query
        description: Only return auto attendants with the matching phone number.
        example: '9705550028'
        schema:
          type: string
  /telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAutoAttendantObject'
              example:
                id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                name: Main Line AA - Test
                enabled: true
                phoneNumber: '+19705550026'
                extension: '200'
                routingPrefix: '1234'
                esn: '1234200'
                tollFreeNumber: false
                firstName: Main Line AA
                lastName: Test
                language: English
                languageCode: en_us
                businessSchedule: AUTOATTENDANT-BUSINESS-HOURS
                holidaySchedule: AUTOATTENDANT-HOLIDAY
                extensionDialing: ENTERPRISE
                nameDialing: ENTERPRISE
                timeZone: America/Los_Angeles
                businessHoursMenu:
                  greeting: DEFAULT
                  extensionEnabled: true
                  audioAnnouncementFile:
                    id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                    fileName: announcement.wav
                    mediaFileType: WAV
                    level: LOCATION
                  keyConfigurations:
                  - key: '0'
                    action: EXIT
                  - key: '1'
                    action: TRANSFER_WITHOUT_PROMPT
                    value: '+19175551092'
                  - key: '2'
                    action: TRANSFER_WITH_PROMPT
                    value: '+19073569984'
                  - key: '3'
                    action: EXTENSION_DIALING
                  - key: '4'
                    action: TRANSFER_TO_MAILBOX
                    value: '+19705550006'
                  - key: '5'
                    action: PLAY_ANNOUNCEMENT
                    audioAnnouncementFile:
                      id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                      fileName: AUDIO_FILE.wav
                      mediaFileType: WAV
                      level: ORGANIZATION
                  - key: '6'
                    action: REPEAT_MENU
                  callTreatment:
                    retryAttemptForNoInput: THREE_TIMES
                    noInputTimer: '60'
                    actionToBePerformed:
                      action: TRANSFER_TO_OPERATOR
                      greeting: CUSTOM
                      audioAnnouncementFile:
                        id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                        fileName: AUDIO_FILE.wav
                        mediaFileType: WAV
                        level: ORGANIZATION
                      transferCallTo: '9878945608'
                afterHoursMenu:
                  greeting: DEFAULT
                  extensionEnabled: true
                  audioAnnouncementFile:
                    id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                    fileName: announcement.wav
                    mediaFileType: WAV
                    level: LOCATION
                  keyConfigurations:
                  - key: '0'
                    action: EXIT
                  - key: '1'
                    action: PLAY_ANNOUNCEMENT
                    audioAnnouncementFile:
                      id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                      fileName: AUDIO_FILE.wav
                      mediaFileType: WAV
                      level: ORGANIZATION
                  callTreatment:
                    retryAttemptForNoInput: THREE_TIMES
                    noInputTimer: '60'
                    actionToBePerformed:
                      action: TRANSFER_TO_OPERATOR
                      greeting: CUSTOM
                      audioAnnouncementFile:
                        id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                        fileName: AUDIO_FILE.wav
                        mediaFileType: WAV
                        level: ORGANIZATION
                      transferCallTo: '9878945608'
                directLineCallerIdName:
                  selection: CUSTOM_NAME
                  customName: Hakim Smith
                dialByName: Hakim Smith
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Get Details for an Auto Attendant
      operationId: getAutoAttendant
      description: 'Retrieve an Auto Attendant details.


        Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.


        Retrieving an auto attendant details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
      tags:
      - 'Features:  Auto Attendant'
      parameters:
      - name: locationId
        in: path
        description: Retrieve an auto attendant details in this location.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1
        schema:
          type: string
      - name: autoAttendantId
        in: path
        description: Retrieve the auto attendant with the matching ID.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
        schema:
          type: string
      - name: orgId
        in: query
        description: Retrieve auto attendant details from this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
    put:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Update an Auto Attendant
      operationId: updateAutoAttendant
      description: 'Update the designated Auto Attendant.


        Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.


        Updating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
      tags:
      - 'Features:  Auto Attendant'
      parameters:
      - name: locationId
        in: path
        description: Location in which this auto attendant exists.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1
        schema:
          type: string
      - name: autoAttendantId
        in: path
        description: Update an auto attendant with the matching ID.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
        schema:
          type: string
      - name: orgId
        in: query
        description: Update an auto attendant from this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              name: Main Line AA - Test New Name
              phoneNumber: '+19705550026'
              extension: '200'
              firstName: Main Line AA
              lastName: Test
              languageCode: en_us
              businessSchedule: TEST-BUSINESS-HOURS-NEW-NAME
              holidaySchedule: AUTOATTENDANT-HOLIDAY
              extensionDialing: ENTERPRISE
              nameDialing: ENTERPRISE
              timeZone: America/Los_Angeles
              businessHoursMenu:
                greeting: DEFAULT
                extensionEnabled: true
                audioAnnouncementFile:
                  id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                  fileName: AUDIO_FILE.wav
                  mediaFileType: WAV
                  level: ORGANIZATION
                keyConfigurations:
                - key: '0'
                  action: EXIT
                - key: '1'
                  action: TRANSFER_WITHOUT_PROMPT
                  value: '+19175551092'
                - key: '2'
                  action: TRANSFER_WITH_PROMPT
                  value: '+19073569984'
                - key: '3'
                  action: EXTENSION_DIALING
                - key: '4'
                  action: TRANSFER_TO_MAILBOX
                  value: '+19705550006'
                - key: '5'
                  action: PLAY_ANNOUNCEMENT
                  audioAnnouncementFile:
                    id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                    fileName: AUDIO_FILE.wav
                    mediaFileType: WAV
                    level: ORGANIZATION
                - key: '6'
                  action: REPEAT_MENU
                callTreatment:
                  retryAttemptForNoInput: THREE_TIMES
                  noInputTimer: '60'
                  actionToBePerformed:
                    action: TRANSFER_TO_OPERATOR
                    greeting: CUSTOM
                    audioAnnouncementFile:
                      id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                      fileName: AUDIO_FILE.wav
                      mediaFileType: WAV
                      level: ORGANIZATION
                    transferCallTo: '9878945608'
              afterHoursMenu:
                greeting: DEFAULT
                extensionEnabled: true
                audioAnnouncementFile:
                  id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                  fileName: AUDIO_FILE.wav
                  mediaFileType: WAV
                  level: ORGANIZATION
                keyConfigurations:
                - key: '0'
                  action: EXIT
                - key: '1'
                  action: PLAY_ANNOUNCEMENT
                  audioAnnouncementFile:
                    id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                    fileName: AUDIO_FILE.wav
                    mediaFileType: WAV
                    level: ORGANIZATION
                callTreatment:
                  retryAttemptForNoInput: THREE_TIMES
                  noInputTimer: '60'
                  actionToBePerformed:
                    action: TRANSFER_TO_OPERATOR
                    greeting: CUSTOM
                    audioAnnouncementFile:
                      id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                      fileName: AUDIO_FILE.wav
                      mediaFileType: WAV
                      level: ORGANIZATION
                    transferCallTo: '9878945608'
              directLineCallerIdName:
                selection: CUSTOM_NAME
                customName: Hakim Smith
              dialByName: Hakim Smith
            schema:
              $ref: '#/components/schemas/ModifyAutoAttendantObject'
    delete:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Delete an Auto Attendant
      operationId: deleteAutoAttendant
      description: 'Delete the designated Auto Attendant.


        Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.


        Deleting an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
      tags:
      - 'Features:  Auto Attendant'
      parameters:
      - name: locationId
        in: path
        description: Location from which to delete an auto attendant.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1
        schema:
          type: string
      - name: autoAttendantId
        in: path
        description: Delete the auto attendant with the matching ID.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
        schema:
          type: string
      - name: orgId
        in: query
        description: Delete the auto attendant from this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
  /telephony/config/locations/{locationId}/autoAttendants:
    post:
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                type: object
                required:
                - id
                properties:
                  id:
                    type: string
                    description: ID of the newly created auto attendant.
              example:
                id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Create an Auto Attendant
      operationId: createAutoAttendant
      description: 'Create new Auto Attendant for the given location.


        Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.


        Creating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
      tags:
      - 'Features:  Auto Attendant'
      parameters:
      - name: locationId
        in: path
        description: Create the auto attendant for this location.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1
        schema:
          type: string
      - name: orgId
        in: query
        description: Create the auto attendant for this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              name: Main Line AA - Test
              phoneNumber: '+19705550026'
              extension: '200'
              firstName: Main Line AA
              lastName: Test
              languageCode: en_us
              businessSchedule: AUTOATTENDANT-BUSINESS-HOURS
              holidaySchedule: AUTOATTENDANT-HOLIDAY
              extensionDialing: ENTERPRISE
              nameDialing: ENTERPRISE
              timeZone: America/Los_Angeles
              businessHoursMenu:
                greeting: DEFAULT
                audioAnnouncementFile:
                  id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw
                  fileName: AUDIO_FILE.wav
                  mediaFileType: WAV
                  level: ORGANIZATION
                extensionEnabled: true
                keyConfigurations:
                - key: '0'
                  action: EXIT
                - key: '1'
                  action: TRANSFER_WITHOUT_PROMPT
                  value: '+19175551092'
                - key: '2'
                  action: TRANSFER_WITH_PROMPT
                  value: '+19073569984'
                - key: '3'
              

# --- truncated at 32 KB (155 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-features-auto-attendant-api-openapi.yml