Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Auto Receptionists API

20 actions 20 updates phrasing extends openapi/zoom-phone-auto-receptionists-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Zoom Phone's API. It is a proposal applied on top of the contract, not a document Zoom Phone publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 20 · first 16 shown; the file carries all of them

$.info
$.paths['/phone/auto_receptionists'].get
$.paths['/phone/auto_receptionists'].post
$.paths['/phone/auto_receptionists/{autoReceptionistId}'].get
$.paths['/phone/auto_receptionists/{autoReceptionistId}'].delete
$.paths['/phone/auto_receptionists/{autoReceptionistId}'].patch
$.paths['/phone/auto_receptionists/{autoReceptionistId}/call_handling/settings'].get
$.paths['/phone/auto_receptionists/{autoReceptionistId}/call_handling/settings/{hourType}'].patch
$.paths['/phone/auto_receptionists/{autoReceptionistId}/phone_numbers'].post
$.paths['/phone/auto_receptionists/{autoReceptionistId}/phone_numbers'].delete
$.paths['/phone/auto_receptionists/{autoReceptionistId}/phone_numbers/{phoneNumberId}'].delete
$.paths['/phone/auto_receptionists/{autoReceptionistId}/policies'].get
$.paths['/phone/auto_receptionists/{autoReceptionistId}/policies'].patch
$.paths['/phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}'].post
$.paths['/phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}'].delete
$.paths['/phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}'].patch

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Auto Receptionists API
  version: 1.0.0
extends: openapi/zoom-phone-auto-receptionists-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 19
- target: $.paths['/phone/auto_receptionists'].get
  update:
    x-apievangelist-phrasing:
      intent: List auto receptionists
      effect: read
      questions:
      - Which auto receptionists are set up in my phone system?
      - Can I page through all the auto attendants on my account?
      instructions:
      - text: List all auto receptionists in my account.
      - text: Show the next {page_size} auto receptionists after token {next_page_token}.
        slots:
          page_size: query.page_size
          next_page_token: query.next_page_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an auto receptionist
      effect: write
      questions:
      - How do I set up a new auto receptionist to answer calls with a greeting menu?
      - Can I create an auto attendant for a specific site?
      instructions:
      - text: Create an auto receptionist named {name}.
        slots:
          name: requestBody.name
      - text: Add a new auto receptionist {name} at site {site_id}.
        slots:
          name: requestBody.name
          site_id: requestBody.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an auto receptionist's details
      effect: read
      questions:
      - What extension, timezone and phone numbers does a given auto receptionist have?
      - Can I look up one auto receptionist's configuration by its ID?
      instructions:
      - text: Show details for auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      - text: Get the extension and numbers of auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a non-primary auto receptionist
      effect: destructive
      questions:
      - Can I delete an auto receptionist that is not the primary one?
      - Is it possible to remove an auto attendant we no longer use?
      instructions:
      - text: Delete auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      - text: Remove the unused non-primary auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an auto receptionist
      effect: write
      questions:
      - Can I rename an auto receptionist or change its extension number?
      - Is it possible to change an auto receptionist's timezone or prompt language?
      instructions:
      - text: Rename auto receptionist {autoReceptionistId} to {name}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          name: requestBody.name
      - text: Set the timezone of auto receptionist {autoReceptionistId} to {timezone}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          timezone: requestBody.timezone
      - text: Change auto receptionist {autoReceptionistId}'s extension to {extension_number}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          extension_number: requestBody.extension_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/call_handling/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an auto receptionist's call handling
      effect: read
      questions:
      - How does an auto receptionist route callers after hours?
      - Can I see the call handling an auto receptionist uses on a specific holiday?
      instructions:
      - text: Show the {hour_type} call handling of auto receptionist {autoReceptionistId}.
        slots:
          hour_type: query.hour_type
          autoReceptionistId: path.autoReceptionistId
      - text: Get auto receptionist {autoReceptionistId}'s routing for holiday {holiday_hour_id}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          holiday_hour_id: query.holiday_hour_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/call_handling/settings/{hourType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an auto receptionist's call handling
      effect: write
      questions:
      - Can I change the greeting an auto receptionist plays during closed hours?
      - Is it possible to reroute an auto receptionist's calls for a particular hour type?
      instructions:
      - text: Update the {hourType} call handling for auto receptionist {autoReceptionistId}.
        slots:
          hourType: path.hourType
          autoReceptionistId: path.autoReceptionistId
      - text: Set the {hourType} greeting of auto receptionist {autoReceptionistId} to {greeting_setting}.
        slots:
          hourType: path.hourType
          autoReceptionistId: path.autoReceptionistId
          greeting_setting: requestBody.greeting_setting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/phone_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign phone numbers to an auto receptionist
      effect: write
      questions:
      - How do I point a main company number at an auto receptionist?
      - Can I assign several available numbers to an auto receptionist at once?
      instructions:
      - text: Assign numbers {phone_numbers} to auto receptionist {autoReceptionistId}.
        slots:
          phone_numbers: requestBody.phone_numbers
          autoReceptionistId: path.autoReceptionistId
      - text: Route the main line {phone_numbers} to auto receptionist {autoReceptionistId}.
        slots:
          phone_numbers: requestBody.phone_numbers
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/phone_numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign all numbers from an auto receptionist
      effect: destructive
      questions:
      - Can I release every phone number attached to an auto receptionist in one go?
      - What happens if I strip all numbers from an auto attendant?
      instructions:
      - text: Unassign all phone numbers from auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      - text: Release every number on auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/phone_numbers/{phoneNumberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign one number from an auto receptionist
      effect: destructive
      questions:
      - Can I detach just one phone number from an auto receptionist and keep the others?
      - Is there a way to remove a single number from an auto attendant?
      instructions:
      - text: Unassign number {phoneNumberId} from auto receptionist {autoReceptionistId}.
        slots:
          phoneNumberId: path.phoneNumberId
          autoReceptionistId: path.autoReceptionistId
      - text: Remove only phone number {phoneNumberId} from auto receptionist {autoReceptionistId}.
        slots:
          phoneNumberId: path.phoneNumberId
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an auto receptionist's policy
      effect: read
      questions:
      - Does an auto receptionist transcribe voicemail or email voicemail notifications?
      - Where can I see the SMS and voicemail policy of an auto receptionist?
      instructions:
      - text: Show the policy settings of auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      - text: Check whether voicemail transcription is on for auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/policies'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an auto receptionist's policy
      effect: write
      questions:
      - Can I turn on voicemail transcription for an auto receptionist?
      - Is it possible to enable SMS or voicemail email notifications on an auto attendant?
      instructions:
      - text: Set voicemail transcription on auto receptionist {autoReceptionistId} to {voicemail_transcription}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          voicemail_transcription: requestBody.voicemail_transcription
      - text: Update the SMS policy for auto receptionist {autoReceptionistId} to {sms}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          sms: requestBody.sms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add voicemail shared access to an auto receptionist
      effect: write
      questions:
      - Can I give a teammate access to an auto receptionist's voicemail box?
      - How do I add a shared voicemail access member to an auto attendant?
      instructions:
      - text: Add {voicemail_access_member} as a voicemail access member on auto receptionist {autoReceptionistId}.
        slots:
          voicemail_access_member: requestBody.voicemail_access_member
          autoReceptionistId: path.autoReceptionistId
      - text: Add a {policyType} policy subsetting to auto receptionist {autoReceptionistId}.
        slots:
          policyType: path.policyType
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove voicemail shared access from an auto receptionist
      effect: destructive
      questions:
      - Can I revoke someone's access to an auto receptionist's voicemail?
      - Which IDs do I need to remove shared voicemail members from an auto attendant?
      instructions:
      - text: Remove shared members {shared_ids} from the {policyType} policy of auto receptionist {autoReceptionistId}.
        slots:
          shared_ids: query.shared_ids
          policyType: path.policyType
          autoReceptionistId: path.autoReceptionistId
      - text: Revoke voicemail access {shared_ids} on auto receptionist {autoReceptionistId} for policy {policyType}.
        slots:
          shared_ids: query.shared_ids
          autoReceptionistId: path.autoReceptionistId
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update voicemail shared access on an auto receptionist
      effect: write
      questions:
      - Can I change the permissions of people who already share an auto receptionist's voicemail?
      - Is it possible to edit the existing voicemail access member list on an auto attendant?
      instructions:
      - text: Update the {policyType} policy subsetting of auto receptionist {autoReceptionistId}.
        slots:
          policyType: path.policyType
          autoReceptionistId: path.autoReceptionistId
      - text: Replace voicemail access members on auto receptionist {autoReceptionistId} with {voicemail_access_members}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          voicemail_access_members: requestBody.voicemail_access_members
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an auto receptionist's hours settings
      effect: read
      questions:
      - What business, break and holiday hours are configured on an auto receptionist?
      - Can I list the holiday hours set for an auto attendant?
      instructions:
      - text: Show the business hours settings of auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      - text: Get the {setting_type} configured on auto receptionist {autoReceptionistId}.
        slots:
          setting_type: query.setting_type
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add holiday or break hours to an auto receptionist
      effect: write
      questions:
      - Can I add a company holiday to an auto receptionist's schedule?
      - Is there a way to create break hours for an auto attendant?
      instructions:
      - text: Add {settingType} to auto receptionist {autoReceptionistId}.
        slots:
          settingType: path.settingType
          autoReceptionistId: path.autoReceptionistId
      - text: Create a new holiday entry on auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete holiday or break hours from an auto receptionist
      effect: destructive
      questions:
      - Can I remove a past holiday from an auto receptionist's schedule?
      - What do I need to delete one break period from an auto attendant?
      instructions:
      - text: Delete holiday {holiday_hour_id} from auto receptionist {autoReceptionistId}'s {settingType}.
        slots:
          holiday_hour_id: query.holiday_hour_id
          autoReceptionistId: path.autoReceptionistId
          settingType: path.settingType
      - text: Remove break {break_hour_id} from the {settingType} of auto receptionist {autoReceptionistId}.
        slots:
          break_hour_id: query.break_hour_id
          settingType: path.settingType
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an auto receptionist's hours settings
      effect: write
      questions:
      - Can I change the existing holiday dates on an auto receptionist?
      - Is it possible to edit an auto attendant's break hours after they are set?
      instructions:
      - text: Update the {settingType} of auto receptionist {autoReceptionistId}.
        slots:
          settingType: path.settingType
          autoReceptionistId: path.autoReceptionistId
      - text: Edit the existing holiday hours on auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      method: generated
      generated: '2026-10-01'