Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Reports API

5 actions 5 updates phrasing extends openapi/zoom-phone-reports-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/reports/call_charges'].get
$.paths['/phone/reports/fax_charges'].get
$.paths['/phone/reports/operationlogs'].get
$.paths['/phone/reports/sms_charges'].get

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 Reports API
  version: 1.0.0
extends: openapi/zoom-phone-reports-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/reports/call_charges'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the monthly call charges report
      effect: read
      questions:
      - How much did our phone calls cost last month?
      - Can I list only the calls that actually incurred charges for a billing account?
      instructions:
      - text: Get the call charges report from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Show call charges for billing account {billing_account_id}.
        slots:
          billing_account_id: query.billing_account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/reports/fax_charges'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the monthly fax charges report
      effect: read
      questions:
      - What did we spend on faxes through the phone system this month?
      - Can I look up the charge for one specific fax?
      instructions:
      - text: Get the fax charges report from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Show the charge for fax {fax_id}.
        slots:
          fax_id: query.fax_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/reports/operationlogs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the phone system admin operation logs
      effect: read
      questions:
      - Which admin changed phone system settings, and when?
      - Can I filter phone admin operation logs by category?
      instructions:
      - text: Get phone system operation logs from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Show admin operation logs in category {category_type}.
        slots:
          category_type: query.category_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/reports/sms_charges'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the monthly SMS/MMS charges report
      effect: read
      questions:
      - How much are we paying for text messages each month?
      - Can the SMS charges report hide messages that cost nothing?
      instructions:
      - text: Get the SMS/MMS charges report from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Show only charged texts with show-charges-only set to {show_charges_only}.
        slots:
          show_charges_only: query.show_charges_only
      method: generated
      generated: '2026-10-01'