Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Carrier Reseller API

5 actions 5 updates phrasing extends openapi/zoom-phone-carrier-reseller-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/carrier_reseller/numbers'].get
$.paths['/phone/carrier_reseller/numbers'].post
$.paths['/phone/carrier_reseller/numbers'].patch
$.paths['/phone/carrier_reseller/numbers/{number}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Carrier Reseller API
  version: 1.0.0
extends: openapi/zoom-phone-carrier-reseller-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/carrier_reseller/numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier reseller numbers
      effect: read
      questions:
      - Which numbers in our carrier reseller master account can be pushed to subaccounts?
      - Can I filter reseller numbers by subaccount or assignment status?
      instructions:
      - text: List phone numbers in the carrier reseller master account.
      - text: List reseller numbers for subaccount {sub_account_id} with status {assigned_status}.
        slots:
          sub_account_id: query.sub_account_id
          assigned_status: query.assigned_status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/carrier_reseller/numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add numbers to a carrier reseller account
      effect: write
      questions:
      - How do I load new numbers into our carrier reseller master account?
      - How many numbers can I add to a reseller account per request?
      instructions:
      - text: Add new phone numbers to the carrier reseller master account.
      - text: Load a batch of up to 200 numbers into the reseller account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/carrier_reseller/numbers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate carrier reseller numbers
      effect: write
      questions:
      - How do I mark reseller phone numbers as active?
      - Can I activate up to 200 numbers in the master account at once?
      instructions:
      - text: Activate pending phone numbers in the carrier reseller master account.
      - text: Change a batch of reseller numbers to active status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/carrier_reseller/numbers/{number}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier reseller number
      effect: destructive
      questions:
      - How do I delete or unassign a number from a carrier reseller account?
      - Can I remove one specific number from the reseller account?
      instructions:
      - text: Delete number {number} from the carrier reseller account.
        slots:
          number: path.number
      - text: Unassign reseller number {number}.
        slots:
          number: path.number
      method: generated
      generated: '2026-10-01'