Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Provision Templates API

6 actions 6 updates phrasing extends openapi/zoom-phone-provision-templates-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/provision_templates'].get

$.paths['/phone/provision_templates'].post

$.paths['/phone/provision_templates/{templateId}'].get

$.paths['/phone/provision_templates/{templateId}'].delete

$.paths['/phone/provision_templates/{templateId}'].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 Provision Templates API
  version: 1.0.0
extends: openapi/zoom-phone-provision-templates-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/provision_templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List desk phone provision templates
      effect: read
      questions:
      - Which provision templates exist for configuring our desk phones?
      - Can I page through every device provisioning template in the account?
      instructions:
      - text: List all provision templates.
      - text: Show {page_size} provision templates per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/provision_templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a provision template
      effect: write
      questions:
      - How do I create a template to push the same config to many desk phones?
      - Can I include custom configuration content in a new provision template?
      instructions:
      - text: Create a provision template named {name}.
        slots:
          name: requestBody.name
      - text: Add provision template {name} with content {content}.
        slots:
          name: requestBody.name
          content: requestBody.content
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/provision_templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a provision template
      effect: read
      questions:
      - What configuration content does a specific provision template contain?
      - Can I look up one provision template by ID?
      instructions:
      - text: Get provision template {templateId}.
        slots:
          templateId: path.templateId
      - text: Show the config content of template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/provision_templates/{templateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provision template
      effect: destructive
      questions:
      - Can I delete a provision template we no longer use?
      - Is removing a desk phone provision template permanent?
      instructions:
      - text: Delete provision template {templateId}.
        slots:
          templateId: path.templateId
      - text: Remove the unused provisioning template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/provision_templates/{templateId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a provision template
      effect: write
      questions:
      - Can I rename a provision template or edit its description?
      - Is it possible to change the configuration content of an existing template?
      instructions:
      - text: Rename provision template {templateId} to {name}.
        slots:
          templateId: path.templateId
          name: requestBody.name
      - text: Replace the content of template {templateId} with {content}.
        slots:
          templateId: path.templateId
          content: requestBody.content
      method: generated
      generated: '2026-10-01'