Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Emergency Addresses API

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

$.info

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

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

$.paths['/phone/emergency_addresses/{emergencyAddressId}'].get

$.paths['/phone/emergency_addresses/{emergencyAddressId}'].delete

$.paths['/phone/emergency_addresses/{emergencyAddressId}'].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 Addresses API
  version: 1.0.0
extends: openapi/zoom-phone-emergency-addresses-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: 5
- target: $.paths['/phone/emergency_addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List emergency addresses
      effect: read
      questions:
      - Which emergency addresses are registered for 911 calls in my account?
      - Can I filter emergency addresses by site, user or verification status?
      instructions:
      - text: List all emergency addresses.
      - text: Show emergency addresses for site {site_id}.
        slots:
          site_id: query.site_id
      - text: Search emergency addresses containing {address_keyword}.
        slots:
          address_keyword: query.address_keyword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/emergency_addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an emergency address
      effect: write
      questions:
      - How do I register a new office address for emergency calling?
      - What happens if the emergency address I submit isn't an exact match?
      instructions:
      - text: Add emergency address {address_line1}, {city}, {state_code} {zip}, {country}.
        slots:
          address_line1: requestBody.address_line1
          city: requestBody.city
          state_code: requestBody.state_code
          zip: requestBody.zip
          country: requestBody.country
      - text: Register {address_line1}, {city}, {state_code} {zip}, {country} as the default emergency address for site {site_id}.
        slots:
          address_line1: requestBody.address_line1
          city: requestBody.city
          state_code: requestBody.state_code
          zip: requestBody.zip
          country: requestBody.country
          site_id: requestBody.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/emergency_addresses/{emergencyAddressId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an emergency address
      effect: read
      questions:
      - Can I see the full details of one emergency address by ID?
      - Is a particular emergency address the default one?
      instructions:
      - text: Get emergency address {emergencyAddressId}.
        slots:
          emergencyAddressId: path.emergencyAddressId
      - text: Show the street and status of emergency address {emergencyAddressId}.
        slots:
          emergencyAddressId: path.emergencyAddressId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/emergency_addresses/{emergencyAddressId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an emergency address
      effect: destructive
      questions:
      - Can I remove an emergency address for an office we closed?
      - Is deleting an emergency address reversible?
      instructions:
      - text: Delete emergency address {emergencyAddressId}.
        slots:
          emergencyAddressId: path.emergencyAddressId
      - text: Remove the old office emergency address {emergencyAddressId}.
        slots:
          emergencyAddressId: path.emergencyAddressId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/emergency_addresses/{emergencyAddressId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an emergency address
      effect: write
      questions:
      - Can I correct the suite number or zip code on an existing emergency address?
      - Is it possible to make an existing emergency address the default?
      instructions:
      - text: Change line 2 of emergency address {emergencyAddressId} to {address_line2}.
        slots:
          emergencyAddressId: path.emergencyAddressId
          address_line2: requestBody.address_line2
      - text: 'Set emergency address {emergencyAddressId} as default: {is_default}.'
        slots:
          emergencyAddressId: path.emergencyAddressId
          is_default: requestBody.is_default
      method: generated
      generated: '2026-10-01'