Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Settings API

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

$.info

$.paths['/phone/policies/{policyType}'].get

$.paths['/phone/policies/{policyType}'].patch

$.paths['/phone/ported_numbers/orders'].get

$.paths['/phone/ported_numbers/orders/{orderId}'].get

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

$.paths['/phone/settings'].patch

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

$.paths['/phone/sip_trunk/trunks'].get

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 Settings API
  version: 1.0.0
extends: openapi/zoom-phone-settings-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: 8
- target: $.paths['/phone/policies/{policyType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level phone policy
      effect: read
      questions:
      - What is our account-wide Zoom Phone policy for a given policy type?
      - Can I read the details of one account policy, like call recording?
      instructions:
      - text: Show the account {policyType} policy.
        slots:
          policyType: path.policyType
      - text: Get account-level policy details for {policyType}.
        slots:
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/policies/{policyType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level phone policy
      effect: write
      questions:
      - How do I change a Zoom Phone policy for the whole account?
      - Can I update one account policy type without touching the others?
      instructions:
      - text: Update the account {policyType} policy.
        slots:
          policyType: path.policyType
      - text: Change the account-wide Zoom Phone {policyType} policy.
        slots:
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/ported_numbers/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List number port orders
      effect: read
      questions:
      - Which numbers have we ported into Zoom Phone, and what's their order status?
      - Where can I see all our phone number porting orders?
      instructions:
      - text: List ported number orders on the Zoom Phone account.
      - text: Show port orders, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/ported_numbers/orders/{orderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a number port order's details
      effect: read
      questions:
      - What's the status of a specific number porting order?
      - Which numbers are included in one port order?
      instructions:
      - text: Show port order {orderId}.
        slots:
          orderId: path.orderId
      - text: Get the numbers and status for porting order {orderId}.
        slots:
          orderId: path.orderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Zoom Phone account settings
      effect: read
      questions:
      - Is BYOC or multiple sites turned on for our Zoom Phone account?
      - What general account settings does our Zoom Phone setup have?
      instructions:
      - text: Show the Zoom Phone account settings.
      - text: Check whether multiple sites is enabled on the phone account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update Zoom Phone account settings
      effect: write
      questions:
      - How do I enable multiple sites on our Zoom Phone account?
      - Can I show device IP addresses in call logs?
      instructions:
      - text: Set multiple sites on the phone account to {multiple_sites}.
        slots:
          multiple_sites: requestBody.multiple_sites
      - text: Update the phone account BYOC setting to {byoc}.
        slots:
          byoc: requestBody.byoc
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sip_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SIP groups
      effect: read
      questions:
      - Which SIP groups exist on our Zoom Phone account?
      - Where do I find the SIP group IDs to attach numbers to?
      instructions:
      - text: List SIP groups on the Zoom Phone account.
      - text: List Zoom Phone SIP groups, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sip_trunk/trunks'].get
  update:
    x-apievangelist-phrasing:
      intent: List BYOC SIP trunks
      effect: read
      questions:
      - Which bring-your-own-carrier SIP trunks are assigned to our account?
      - Can I see our BYOC trunk configuration through Zoom Phone?
      instructions:
      - text: List the account's BYOC SIP trunks.
      - text: Show assigned BYOC trunks on Zoom Phone, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'