Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Emergency Service Locations API

7 actions 7 updates phrasing extends openapi/zoom-phone-emergency-service-locations-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 7

$.info

$.paths['/phone/batch_locations'].post

$.paths['/phone/locations'].get

$.paths['/phone/locations'].post

$.paths['/phone/locations/{locationId}'].get

$.paths['/phone/locations/{locationId}'].delete

$.paths['/phone/locations/{locationId}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Emergency Service Locations API
  version: 1.0.0
extends: openapi/zoom-phone-emergency-service-locations-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: 6
- target: $.paths['/phone/batch_locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add emergency service locations in bulk
      effect: write
      questions:
      - Can I upload many emergency service locations in one request?
      - How do I bulk-load a site's emergency locations?
      instructions:
      - text: Batch add emergency locations {locations}.
        slots:
          locations: requestBody.locations
      - text: Bulk add emergency service locations {locations} to site {site_id}.
        slots:
          locations: requestBody.locations
          site_id: requestBody.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List emergency service locations
      effect: read
      questions:
      - Which emergency service locations are defined on our account?
      - Do I need a site ID to list emergency locations when multiple sites are on?
      instructions:
      - text: List all emergency service locations.
      - text: List emergency locations for site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an emergency service location
      effect: write
      questions:
      - How do I add a single emergency location tied to a network?
      - Can an emergency location match on BSSID or IP address?
      instructions:
      - text: Add emergency location {name} at emergency address {emergency_address_id}.
        slots:
          name: requestBody.name
          emergency_address_id: requestBody.emergency_address_id
      - text: Add location {name} for address {emergency_address_id} matched by BSSID {bssid}.
        slots:
          name: requestBody.name
          emergency_address_id: requestBody.emergency_address_id
          bssid: requestBody.bssid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/locations/{locationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an emergency service location
      effect: read
      questions:
      - What network details does one emergency location use?
      - Where can I check a single emergency service location?
      instructions:
      - text: Show emergency location {locationId}.
        slots:
          locationId: path.locationId
      - text: Get the network match details of location {locationId}.
        slots:
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/locations/{locationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an emergency service location
      effect: destructive
      questions:
      - Can I remove an emergency location we no longer use?
      - What deletes one emergency service location?
      instructions:
      - text: Delete emergency location {locationId}.
        slots:
          locationId: path.locationId
      - text: Remove emergency service location {locationId}.
        slots:
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/locations/{locationId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an emergency service location
      effect: write
      questions:
      - How do I change the IP range or BSSID of an emergency location?
      - Can I point an emergency location at a different address?
      instructions:
      - text: Rename emergency location {locationId} to {name}.
        slots:
          locationId: path.locationId
          name: requestBody.name
      - text: Set emergency location {locationId}'s public IP to {public_ip}.
        slots:
          locationId: path.locationId
          public_ip: requestBody.public_ip
      method: generated
      generated: '2026-10-01'