Zoom Phone Auto Receptionists API

openapi: 3.2.0
info:
  title: Phone Auto Receptionists API
  description: "You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the [Zoom App Marketplace](https://marketplace.zoom.us/).\n\n  To learn how to get your credentials and create private or public applications, see Zoom APIs use [OAuth 2.0 authorization](https://developers.zoom.us/docs/integrations/oauth/). \n\n  All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You'll receive a `403` error message if you have not set up Zoom Phone."
  termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
  contact:
    name: Zoom Developers
    url: https://developer.zoom.us/
  version: '2'
servers:
- url: https://api.zoom.us/v2
tags:
- name: Auto Receptionists
paths:
  /phone/auto_receptionists:
    get:
      tags:
      - Auto Receptionists
      summary: List auto receptionists
      description: 'Returns a list of auto receptionists.


        **Prerequisites:**

        * Pro or a higher account with Zoom Phone license.

        * Account owner or admin permissions.




        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_auto_receptionists:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`'
      operationId: listAutoReceptionists
      parameters:
      - name: page_size
        in: query
        description: The total number of records returned from a single API call.
        required: false
        schema:
          maximum: 100
          type: integer
          example: 30
          default: 30
      - name: next_page_token
        in: query
        description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
        required: false
        schema:
          type: string
          example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
      responses:
        '200':
          description: "**HTTP Status Code:** `200` **OK**  \n \nList of [auto receptionists](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-auto-receptionists) retrieved successfully."
          content:
            application/json:
              schema:
                type: object
                properties:
                  auto_receptionists:
                    type: array
                    items:
                      type: object
                      properties:
                        cost_center:
                          type: string
                          description: '`nullable` Cost center name.'
                          example: testCostCenter
                        department:
                          type: string
                          description: '`nullable` Department name.'
                          example: testDepartment
                        extension_id:
                          type: string
                          description: Extension ID
                          example: WfsrPERXS8inWrpH1Hi_KQ
                        extension_number:
                          type: integer
                          description: Extension number of the auto receptionist.
                          format: int64
                          example: 555550000000001
                        id:
                          type: string
                          description: The unique identifier of the auto receptionist.
                          example: nqerMCD0Tu6RPGoCpVbPtA
                        name:
                          type: string
                          description: Name of the auto receptionist.
                          example: JamieAuto
                        timezone:
                          type: string
                          description: '[Timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) of the Auto Receptionist.'
                          example: Pacific/Midway
                        audio_prompt_language:
                          type: string
                          description: Audio prompt language.
                          example: en-US
                        holiday_hours:
                          type: array
                          description: The holiday hours.
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: The holiday ID.
                                example: i3gP6xFUTHqSFrIE6nHs7Q
                              name:
                                type: string
                                description: The name of the holiday.
                                example: Holiday 1
                              from:
                                type: string
                                description: The holiday start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
                                format: date-time
                                example: '2022-03-08T16:00:00Z'
                              to:
                                type: string
                                description: The holiday end date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
                                format: date-time
                                example: '2022-03-09T16:00:00Z'
                        phone_numbers:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Unique identifier of the phone number.
                                example: KsxwNLEhQ0SJ4U4Bor4ShA
                              number:
                                type: string
                                description: Phone number.
                                example: '+12058945717'
                        site:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) to which the common area desk phone is assigned.
                              example: O4rBC_zEQnCVoiHfXKGKNA
                            name:
                              type: string
                              description: Name of the site.
                              example: jamietestsite
                  next_page_token:
                    type: string
                    description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
                    example: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2
                  page_size:
                    type: integer
                    description: Total number of records returned from a single API call.
                    example: 30
                  total_records:
                    type: integer
                    description: Total number of records found for this query.
                    example: 1
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:list_auto_receptionists:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:list_auto_receptionists:admin
    post:
      tags:
      - Auto Receptionists
      summary: Add an auto receptionist
      description: "Adds an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) to a Zoom Phone. Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area, voicemail or an IVR system. \n\n**Prerequisites:**\n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:auto_receptionist:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
      operationId: addAutoReceptionist
      requestBody:
        content:
          application/json:
            schema:
              required:
              - name
              type: object
              properties:
                name:
                  type: string
                  description: Provide a name to help identify the auto receptionist.
                  example: JamieAuto
                site_id:
                  type: string
                  description: Unique identifier of the site where the auto receptionist is to be assigned. This field is required only if you have [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) enabled.
                  example: O4rBC_zEQnCVoiHfXKGKNA
      responses:
        '201':
          description: '**HTTP Status Code:** `201` **Created**


            Auto receptionist added successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  extension_number:
                    type: integer
                    description: ' Extension number assigned to the auto receptionist.'
                    format: int64
                    example: 555550000000001
                  id:
                    type: string
                    description: Auto receptionist ID. The unique identifier of the auto receptionist.
                    example: nqerMCD0Tu6RPGoCpVbPtA
                  name:
                    type: string
                    description: ' Name of the auto receptionist.'
                    example: JamieAuto
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n  <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:write:auto_receptionist:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:write:auto_receptionist:admin
  /phone/auto_receptionists/{autoReceptionistId}:
    get:
      tags:
      - Auto Receptionists
      summary: Get an auto receptionist
      description: 'Returns information on a specific auto receptionist.


        **Prerequisites:**

        * Pro or a higher account with Zoom Phone license

        * Account owner or admin permissions


        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:auto_receptionist:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`'
      operationId: getAutoReceptionistDetail
      parameters:
      - name: autoReceptionistId
        in: path
        required: true
        schema:
          type: string
          example: nqerMCD0Tu6RPGoCpVbPtA
      responses:
        '200':
          description: "**HTTP Status Code:** `200` **OK**  \n \nSuccessfully get an auto receptionist detail."
          content:
            application/json:
              schema:
                type: object
                properties:
                  cost_center:
                    type: string
                    description: '`nullable` The cost center name.'
                    example: testCostCenter
                  department:
                    type: string
                    description: '`nullable` The name of the department.'
                    example: testDepartment
                  extension_id:
                    type: string
                    description: The extension ID
                    example: WfsrPERXS8inWrpH1Hi_KQ
                  extension_number:
                    type: integer
                    description: The extension number of the auto receptionist.
                    format: int64
                    example: 555550000000001
                  name:
                    type: string
                    description: The name of the auto receptionist.
                    example: JamieAuto
                  timezone:
                    type: string
                    description: '[Timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) of the auto receptionist.'
                    example: Pacific/Midway
                  audio_prompt_language:
                    type: string
                    description: "The language for all default audio prompts for the auto receptionist. \n* `en-US` : English (US) \n* `en-GB` : English (UK) \n* `es-US` : Spanish (US) \n* `fr-CA` : French (Canada) \n* `da-DK` : Danish (Denmark) \n* `de-DE` : German (Germany) \n* `es-ES` : Spanish (Spain) \n* `fr-FR` : French (France) \n* `it-IT` : Italian (Italy) \n* `nl-NL` : Dutch (Netherlands) \n* `pt-PT` : Portuguese (Portugal) \n* `ja` : Japanese \n* `ko-KR` : Korean (Korea) \n* `pt-BR` : Portuguese (Brazil) \n* `zh-CN` : Chinese (PRC)"
                    example: en-US
                    enum:
                    - en-US
                    - en-GB
                    - es-US
                    - fr-CA
                    - da-DK
                    - de-DE
                    - es-ES
                    - fr-FR
                    - it-IT
                    - nl-NL
                    - pt-PT
                    - ja
                    - ko-KR
                    - pt-BR
                    - zh-CN
                  default_transcription_language:
                    type: string
                    description: "The default language selection for features such as voicemail and call recording.\n* `en-US` : English (US) \n* `en-GB` : English (UK) \n* `es-US` : Spanish (US) \n* `fr-CA` : French (Canada) \n* `da-DK` : Danish (Denmark) \n* `de-DE` : German (Germany) \n* `es-ES` : Spanish (Spain) \n* `fr-FR` : French (France) \n* `it-IT` : Italian (Italy) \n* `nl-NL` : Dutch (Netherlands) \n* `pt-PT` : Portuguese (Portugal) \n* `ja` : Japanese \n* `ko-KR` : Korean (Korea) \n* `pt-BR` : Portuguese (Brazil) \n* `zh-CN` : Chinese (PRC)"
                    example: en-US
                    enum:
                    - en-US
                    - en-GB
                    - es-US
                    - fr-CA
                    - da-DK
                    - de-DE
                    - es-ES
                    - fr-FR
                    - it-IT
                    - nl-NL
                    - pt-PT
                    - ja
                    - ko-KR
                    - pt-BR
                    - zh-CN
                  holiday_hours:
                    maxItems: 100
                    type: array
                    description: The holiday hours.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The holiday ID.
                          example: i3gP6xFUTHqSFrIE6nHs7Q
                        name:
                          type: string
                          description: The name of the holiday.
                          example: Holiday 1
                        from:
                          type: string
                          description: The holiday start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
                          format: date-time
                          example: '2022-03-08T16:00:00Z'
                        to:
                          type: string
                          description: The holiday end date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
                          format: date-time
                          example: '2022-03-09T16:00:00Z'
                  phone_numbers:
                    maxItems: 50
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique identifier of the phone number.
                          example: KsxwNLEhQ0SJ4U4Bor4ShA
                        number:
                          type: string
                          description: The phone number.
                          example: '+12058945717'
                  site:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) to which the common area desk phone is assigned.
                        example: O4rBC_zEQnCVoiHfXKGKNA
                      name:
                        type: string
                        description: The name of the site.
                        example: jamietestsite
                  recording_storage_location:
                    type: string
                    description: "Where the recording will be stored. Recording includes Phone recordings, voicemail, voicemail transcripts, and custom greeting prompts. \n* `US` : United States \n* `AU` : Australia \n* `CA` : Canada \n* `DE` : Germany \n* `IN` : India \n* `JP` : Japan \n* `SG` : Singapore \n* `BR` : Brazil \n* `CN` : China \n* `MX` : Mexico \n\n<b>Note:</b> \n* If the setting is locked at the Account level, it can't be updated."
                    example: US
                    enum:
                    - US
                    - AU
                    - CA
                    - DE
                    - IN
                    - JP
                    - SG
                    - BR
                    - CN
                    - MX
                  own_storage_name:
                    type: string
                    description: The name of your own storage. Use your own storage provided by Oracle Cloud Infrastructure (OCI) to store Zoom Phone recordings, voicemails, and voicemail transcripts, and custom greeting prompts.
                    example: us-oracle-storage
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n Validation Failed. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:auto_receptionist:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:auto_receptionist:admin
    delete:
      tags:
      - Auto Receptionists
      summary: Delete a non-primary auto receptionist
      description: '[Deletes a non-primary auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3).


        An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area (phone), or to a voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options.



        **Prerequisites:**

        * Pro or higher account with Zoom Phone license.




        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:auto_receptionist:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`'
      operationId: deleteAutoReceptionist
      parameters:
      - name: autoReceptionistId
        in: path
        description: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists).
        required: true
        schema:
          type: string
          example: nqerMCD0Tu6RPGoCpVbPtA
      responses:
        '204':
          description: "**HTTP Status Code:** `204`  \n  **No Content**  \n \nAuto Receptionist deleted successfully."
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Unable to delete main Auto receptionist.<br><br> <br>\n**Error Code:** `404` <br>\n AutoReceptionist does not exist: {autoReceptionistId}. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:delete:auto_receptionist:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:delete:auto_receptionist:admin
    patch:
      tags:
      - Auto Receptionists
      summary: Update an auto receptionist
      description: '[Changes information](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3) such as the display name and the extension number assigned to the main auto receptionist.


        An auto receptionist answers calls with a personalized recording. And it routes calls to a phone user, call queue, common area, or voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options.



        **Prerequisites:**

        * Pro or higher account with Zoom Phone license.




        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
      operationId: updateAutoReceptionist
      parameters:
      - name: autoReceptionistId
        in: path
        description: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists).
        required: true
        schema:
          type: string
          example: nqerMCD0Tu6RPGoCpVbPtA
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cost_center:
                  type: string
                  description: The cost center name.
                  example: testCostCenter
                department:
                  type: string
                  description: The department name.
                  example: testDepartment
                extension_number:
                  type: integer
                  description: The extension number to be assigned to the auto receptionist. If site code is enabled, provide the short extension number instead.
                  format: int64
                  example: 555550000000001
                name:
                  maxLength: 32
                  type: string
                  description: Display name of the auto receptionist.
                  example: JamieAuto
                audio_prompt_language:
                  type: string
                  description: "The language for all default audio prompts for the Auto Receptionist. \n* `en-US` : English (US) \n* `en-GB` : English (UK) \n* `es-US` : Spanish (US) \n* `fr-CA` : French (Canada) \n* `da-DK` : Danish (Denmark) \n* `de-DE` : German (Germany) \n* `es-ES` : Spanish (Spain) \n* `fr-FR` : French (France) \n* `it-IT` : Italian (Italy) \n* `nl-NL` : Dutch (Netherlands) \n* `pt-PT` : Portuguese (Portugal) \n* `ja` : Japanese \n* `ko-KR` : Korean (Korea) \n* `pt-BR` : Portuguese (Brazil) \n* `zh-CN` : Chinese (PRC)"
                  example: en-US
                  enum:
                  - en-US
                  - en-GB
                  - es-US
                  - fr-CA
                  - da-DK
                  - de-DE
                  - es-ES
                  - fr-FR
                  - it-IT
                  - nl-NL
                  - pt-PT
                  - ja
                  - ko-KR
                  - pt-BR
                  - zh-CN
                default_transcription_language:
                  type: string
                  description: "The default language selection for features such as voicemail and call recording.\n* `en-US` : English (US) \n* `en-GB` : English (UK) \n* `es-US` : Spanish (US) \n* `fr-CA` : French (Canada) \n* `da-DK` : Danish (Denmark) \n* `de-DE` : German (Germany) \n* `es-ES` : Spanish (Spain) \n* `fr-FR` : French (France) \n* `it-IT` : Italian (Italy) \n* `nl-NL` : Dutch (Netherlands) \n* `pt-PT` : Portuguese (Portugal) \n* `ja` : Japanese \n* `ko-KR` : Korean (Korea) \n* `pt-BR` : Portuguese (Brazil) \n* `zh-CN` : Chinese (PRC)"
                  example: en-US
                  enum:
                  - en-US
                  - en-GB
                  - es-US
                  - fr-CA
                  - da-DK
                  - de-DE
                  - es-ES
                  - fr-FR
                  - it-IT
                  - nl-NL
                  - pt-PT
                  - ja
                  - ko-KR
                  - pt-BR
                  - zh-CN
                timezone:
                  type: string
                  description: The [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) of the Auto Receptionist.
                  example: Pacific/Midway
                recording_storage_location:
                  type: string
                  description: "Where the recording will be stored. The recording includes Phone recordings, voicemail, voicemail transcripts, and custom greeting prompts. \n* `US` : United States \n* `AU` : Australia \n* `CA` : Canada \n* `DE` : Germany \n* `IN` : India \n* `JP` : Japan \n* `SG` : Singapore \n* `BR` : Brazil \n* `CN` : China \n* `MX` : Mexico \n\n<b>Note:</b> \n* If the setting is locked at the Account level, it can't be updated."
                  example: US
                  enum:
                  - US
                  - AU
                  - CA
                  - DE
                  - IN
                  - JP
                  - SG
                  - BR
                  - CN
                  - MX
      responses:
        '204':
          description: "**HTTP Status Code:** `204`  \n  **No Content**  \n \nAuto Receptionist details updated sucessfully."
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n Extension Number must be {min} to {max} digits<br>\nValidation Failed. AutoReceptionist does not exist, AutoReceptionistId: {autoReceptionistId}<br>\nAudio prompt language is invalid:{0}<br>\nTime zone is invalid:{0}<br> <br>\n**Error Code:** `400` <br>\n Invalid short number length.<br>\nInvalid full extension number length.<br><br> <br>\n**Error Code:** `10001` <br>\n Number {extensionNumber} is a reserved extension number.<br>\nExtension number {extensionNumber} is already used.<br>\nLanguage setting is invalid. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:update:auto_receptionist:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:update:auto_receptionist:admin
  /phone/auto_receptionists/{autoReceptionistId}/call_handling/settings:
    get:
      tags:
      - Auto Receptionists
      summary: Get auto receptionist call handling setting
      description: 'Returns the call handling setting of an auto receptionist for the specified hour type.


        **Prerequisites**

        * A Business or Enterprise account

        * A Zoom Phone license


        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:auto_receptionist_call_handling_setting:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
      operationId: getAutoReceptionistCallHandlingSettings
      parameters:
      - name: autoReceptionistId
        in: path
        description: The auto receptionist ID.
        required: true
        schema:
          type: string
          example: 1M9iN6myT4qVx7QbJ8z9aw
      - name: hour_type
        in: query
        description: The hour type of the call handling setting.
        required: false
        schema:
          type: string
          example: business_hours
          enum:
          - business_hours
          - closed_hours
          - holiday_hours
          - break_hours
      - name: holiday_hour_id
        in: query
        description: The holiday hour ID. Required when `hour_type` is `holiday_hours`.
        required: false
        schema:
          type: string
          example: TNxfEp2WT9emyCsAQt4qnA
      - name: break_hour_id
        in: query
        description: The break hour ID. Required when `hour_type` is `break_hours`.
        required: false
        schema:
          type: string
          example: ULfeE4mgSImyelNmTekUfg
      responses:
        '200':
          description: '**HTTP Status Code:** `200` Auto receptionist call handling setting retrieved successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  greeting_setting:
                    type: object
                    properties:
                      greeting_prompt:
                        type: object
                        properties:
                          audio_id:
                            type: string
                            description: The audio prompt file ID.
                            example: yCT14TwySDGVUypVlKNEyA
                          audio_name:
                            type: string
                            description: The audio prompt file name.
                            example: greeting-prompt.mp3
                        description: The audio file played when an incoming call to the auto receptionist is answered.
                    description: The greeting and audio prompt settings.
                  call_handling_setting:
                   

# --- truncated at 32 KB (168 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoom-phone/refs/heads/main/openapi/zoom-phone-auto-receptionists-api-openapi.yml