# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Sites API
  version: 1.0.0
extends: openapi/zoom-phone-sites-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: 12
- target: $.paths['/phone/sites'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone sites
      effect: read
      questions:
      - Which phone sites does our Zoom Phone account have?
      - Can I search phone sites by name?
      instructions:
      - text: List all phone sites on the account.
      - text: Find phone sites named {site_name}.
        slots:
          site_name: query.site_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a phone site
      effect: write
      questions:
      - How do I add a new office location as a phone site?
      - What do I need, like an emergency address and auto receptionist name, to create a site?
      instructions:
      - text: Create a phone site named {name} with auto receptionist {auto_receptionist_name} and emergency address {default_emergency_address}.
        slots:
          name: requestBody.name
          auto_receptionist_name: requestBody.auto_receptionist_name
          default_emergency_address: requestBody.default_emergency_address
      - text: Create site {name} with site code {site_code}, auto receptionist {auto_receptionist_name} and address {default_emergency_address}.
        slots:
          name: requestBody.name
          site_code: requestBody.site_code
          auto_receptionist_name: requestBody.auto_receptionist_name
          default_emergency_address: requestBody.default_emergency_address
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a phone site's details
      effect: read
      questions:
      - What are the details of one phone site, like its site code?
      - Where can I check a single site's configuration?
      instructions:
      - text: Show details for phone site {siteId}.
        slots:
          siteId: path.siteId
      - text: Look up the site code of phone site {siteId}.
        slots:
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a phone site and move its assets
      effect: destructive
      questions:
      - Can I delete a phone site and move its users and numbers elsewhere?
      - Which site receives the users and phones when I delete a site?
      instructions:
      - text: Delete phone site {siteId} and transfer its assets to site {transfer_site_id}.
        slots:
          siteId: path.siteId
          transfer_site_id: query.transfer_site_id
      - text: Remove site {siteId}, moving its users, numbers and phones to {transfer_site_id}.
        slots:
          siteId: path.siteId
          transfer_site_id: query.transfer_site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a phone site's details
      effect: write
      questions:
      - How do I rename a phone site or change its site code?
      - Can I change a site's caller ID name or default emergency address?
      instructions:
      - text: Rename phone site {siteId} to {name}.
        slots:
          siteId: path.siteId
          name: requestBody.name
      - text: Set the caller ID name of site {siteId} to {caller_id_name}.
        slots:
          siteId: path.siteId
          caller_id_name: requestBody.caller_id_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_caller_id/customized_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's custom outbound caller ID numbers
      effect: read
      questions:
      - Which numbers can be used as a site-level custom outbound caller ID?
      - Can I search a site's customized caller ID numbers by keyword?
      instructions:
      - text: List customized outbound caller ID numbers for site {siteId}.
        slots:
          siteId: path.siteId
      - text: Search site {siteId}'s custom caller ID numbers for {keyword}.
        slots:
          siteId: path.siteId
          keyword: query.keyword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_caller_id/customized_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add custom outbound caller ID numbers to a site
      effect: write
      questions:
      - How do I add numbers to a site's custom outbound caller ID list?
      - Can I make extra numbers available as caller ID for one site?
      instructions:
      - text: Add phone numbers {phone_number_ids} as custom outbound caller IDs for site {siteId}.
        slots:
          phone_number_ids: requestBody.phone_number_ids
          siteId: path.siteId
      - text: Let site {siteId} show {phone_number_ids} as outbound caller ID.
        slots:
          phone_number_ids: requestBody.phone_number_ids
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_caller_id/customized_numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove custom outbound caller ID numbers from a site
      effect: destructive
      questions:
      - Can I take numbers off a site's custom outbound caller ID list?
      - What removes a site-level customized caller ID number?
      instructions:
      - text: Remove custom caller ID entries {customize_ids} from site {siteId}.
        slots:
          customize_ids: query.customize_ids
          siteId: path.siteId
      - text: Delete the customized outbound caller numbers from site {siteId}.
        slots:
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/settings/{settingType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one type of setting for a phone site
      effect: read
      questions:
      - What are a site's business hours or holiday settings?
      - Can I read a single setting type, like desk phone, for one site?
      instructions:
      - text: Show the {settingType} setting for site {siteId}.
        slots:
          settingType: path.settingType
          siteId: path.siteId
      - text: Get site {siteId}'s {settingType} configuration.
        slots:
          settingType: path.settingType
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/settings/{settingType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a holiday or device setting to a site
      effect: write
      questions:
      - How do I add holidays to a phone site?
      - Can I add a desk phone setting for a particular device type at a site?
      instructions:
      - text: Add holidays {holidays} to site {siteId} under setting {settingType}.
        slots:
          holidays: requestBody.holidays
          siteId: path.siteId
          settingType: path.settingType
      - text: Add a {settingType} setting for device type {device_type} at site {siteId}.
        slots:
          settingType: path.settingType
          device_type: requestBody.device_type
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/settings/{settingType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a phone site setting
      effect: destructive
      questions:
      - Can I remove a holiday from a phone site's settings?
      - How do I delete a site setting for one device type?
      instructions:
      - text: Delete holiday {holiday_id} from site {siteId}'s {settingType} setting.
        slots:
          holiday_id: query.holiday_id
          siteId: path.siteId
          settingType: path.settingType
      - text: Remove the {settingType} setting from site {siteId}.
        slots:
          settingType: path.settingType
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/settings/{settingType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a phone site's settings
      effect: write
      questions:
      - How do I change a site's business hours or closed-hours routing?
      - Can I turn on location-based routing for a site?
      - Is dial by name configurable per site?
      instructions:
      - text: Update site {siteId}'s {settingType} business hours to {business_hours}.
        slots:
          siteId: path.siteId
          settingType: path.settingType
          business_hours: requestBody.business_hours
      - text: Set location-based routing on site {siteId} ({settingType}) to {location_based_routing}.
        slots:
          siteId: path.siteId
          settingType: path.settingType
          location_based_routing: requestBody.location_based_routing
      method: generated
      generated: '2026-10-01'