Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Provider Exchange API

6 actions 6 updates phrasing extends openapi/zoom-phone-provider-exchange-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/carrier_peering/numbers'].get

$.paths['/phone/peering/numbers'].get

$.paths['/phone/peering/numbers'].post

$.paths['/phone/peering/numbers'].delete

$.paths['/phone/peering/numbers'].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 Provider Exchange API
  version: 1.0.0
extends: openapi/zoom-phone-provider-exchange-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/carrier_peering/numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List numbers a carrier pushed via phone peering
      effect: read
      questions:
      - Which numbers has my carrier pushed to Zoom customers under the phone peering endpoint?
      - Can I check whether one specific number was pushed by our carrier?
      instructions:
      - text: List carrier peering phone numbers pushed to customers.
      - text: Look up carrier-pushed number {phone_number} in phone peering.
        slots:
          phone_number: query.phone_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/peering/numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List Provider Exchange peering numbers
      effect: read
      questions:
      - What numbers have we sent to Zoom through the Provider Exchange?
      - Can I filter Provider Exchange numbers by carrier code?
      instructions:
      - text: List the phone numbers sent through the Provider Exchange.
      - text: List Provider Exchange numbers for carrier {carrier_code}.
        slots:
          carrier_code: query.carrier_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/peering/numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add numbers through the Provider Exchange
      effect: write
      questions:
      - How does a peering partner add phone numbers to Zoom via the Provider Exchange?
      - Do I need a signed MoU before adding numbers through the Provider Exchange?
      instructions:
      - text: Add {phone_numbers} to Zoom through the Provider Exchange.
        slots:
          phone_numbers: requestBody.phone_numbers
      - text: Add Provider Exchange numbers {phone_numbers} for carrier {carrier_code}.
        slots:
          phone_numbers: requestBody.phone_numbers
          carrier_code: requestBody.carrier_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/peering/numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove numbers from the Provider Exchange
      effect: destructive
      questions:
      - How do I withdraw numbers we added to Zoom through the Provider Exchange?
      - Can I remove Provider Exchange numbers for just one carrier code?
      instructions:
      - text: Remove {phone_numbers} from the Provider Exchange.
        slots:
          phone_numbers: query.phone_numbers
      - text: Withdraw Provider Exchange numbers {phone_numbers} for carrier {carrier_code}.
        slots:
          phone_numbers: query.phone_numbers
          carrier_code: query.carrier_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/peering/numbers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update numbers in the Provider Exchange
      effect: write
      questions:
      - Can I update numbers already sent to Zoom via the Provider Exchange?
      - How do I change details on Provider Exchange numbers for a carrier?
      instructions:
      - text: Update {phone_numbers} in the Provider Exchange.
        slots:
          phone_numbers: requestBody.phone_numbers
      - text: Update Provider Exchange numbers {phone_numbers} for carrier {carrier_code}.
        slots:
          phone_numbers: requestBody.phone_numbers
          carrier_code: requestBody.carrier_code
      method: generated
      generated: '2026-10-01'