Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Accounts API

5 actions 5 updates phrasing extends openapi/zoom-phone-accounts-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 5

$.info

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

$.paths['/phone/outbound_caller_id/customized_numbers'].get

$.paths['/phone/outbound_caller_id/customized_numbers'].post

$.paths['/phone/outbound_caller_id/customized_numbers'].delete

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 Accounts API
  version: 1.0.0
extends: openapi/zoom-phone-accounts-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: 4
- target: $.paths['/phone/account_settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's Zoom Phone settings by type
      effect: read
      questions:
      - What Zoom Phone settings are configured for the account, by setting type?
      - Can I fetch only certain account setting types?
      instructions:
      - text: List the account's Zoom Phone settings.
      - text: List account Zoom Phone settings of types {setting_types}.
        slots:
          setting_types: query.setting_types
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_caller_id/customized_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level custom caller ID numbers
      effect: read
      questions:
      - Which numbers can be shown as our account-level outbound caller ID?
      - Can I see only the numbers already selected for custom caller ID?
      instructions:
      - text: List the account's customized outbound caller ID numbers.
      - text: Show custom caller ID numbers with selected {selected} at site {site_id}.
        slots:
          selected: query.selected
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_caller_id/customized_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add account-level custom caller ID numbers
      effect: write
      questions:
      - How do I add a number to the account's customized outbound caller ID list?
      - Why can't I manage account-level caller ID when multiple sites is on?
      instructions:
      - text: Add numbers {phone_number_ids} to the account's custom outbound caller ID.
        slots:
          phone_number_ids: requestBody.phone_number_ids
      - text: Allow {phone_number_ids} as account-level outbound caller ID.
        slots:
          phone_number_ids: requestBody.phone_number_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_caller_id/customized_numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove account-level custom caller ID numbers
      effect: destructive
      questions:
      - How do I stop a number being offered as the account's custom caller ID?
      - Can I remove several custom caller ID numbers at once?
      instructions:
      - text: Remove custom caller ID entries {customize_ids} from the account.
        slots:
          customize_ids: query.customize_ids
      - text: Delete account-level outbound caller ID numbers {customize_ids}.
        slots:
          customize_ids: query.customize_ids
      method: generated
      generated: '2026-10-01'