Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Number Management Setting API

5 actions 5 updates phrasing extends openapi/zoom-phone-setting-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['/number_management/ported_numbers/orders'].get

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

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

$.paths['/number_management/sip_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 Number Management Setting API
  version: 1.0.0
extends: openapi/zoom-phone-setting-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['/number_management/ported_numbers/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List port orders in number management
      effect: read
      questions:
      - Which numbers have we ported, as recorded in number management?
      - Can I page through number management's port orders?
      instructions:
      - text: List port orders in number management.
      - text: Show number management port orders, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/ported_numbers/orders/{orderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a port order from number management
      effect: read
      questions:
      - What's the status of one port order according to number management?
      - Which numbers belong to a number management port order?
      instructions:
      - text: Show number management port order {orderId}.
        slots:
          orderId: path.orderId
      - text: Get the details of ported order {orderId} in number management.
        slots:
          orderId: path.orderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sip_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SIP groups for a product
      effect: read
      questions:
      - Which SIP groups exist for a given product in number management?
      - Can I list SIP groups by allocated product?
      instructions:
      - text: List SIP groups for {allocated_product}.
        slots:
          allocated_product: query.allocated_product
      - text: Show number management SIP groups allocated to {allocated_product}.
        slots:
          allocated_product: query.allocated_product
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sip_trunks'].get
  update:
    x-apievangelist-phrasing:
      intent: List BYOC SIP trunks for a product
      effect: read
      questions:
      - Which BYOC SIP trunks are assigned for a particular product?
      - Can I see number management's BYOC trunks by allocated product?
      instructions:
      - text: List BYOC SIP trunks for {allocated_product}.
        slots:
          allocated_product: query.allocated_product
      - text: Show number management BYOC trunks allocated to {allocated_product}.
        slots:
          allocated_product: query.allocated_product
      method: generated
      generated: '2026-10-01'