Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Setting Templates API

5 actions 5 updates phrasing extends openapi/zoom-phone-setting-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 5

$.info
$.paths['/phone/setting_templates'].get
$.paths['/phone/setting_templates'].post
$.paths['/phone/setting_templates/{templateId}'].get
$.paths['/phone/setting_templates/{templateId}'].patch

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 Setting Templates API
  version: 1.0.0
extends: openapi/zoom-phone-setting-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: 4
- target: $.paths['/phone/setting_templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone setting templates
      effect: read
      questions:
      - Which phone setting templates have been created?
      - Can I list the setting templates for one site?
      instructions:
      - text: List all phone setting templates.
      - text: List setting templates at site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/setting_templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a phone setting template
      effect: write
      questions:
      - How do I create a template of default phone settings?
      - Which template types can I create, for users or other targets?
      instructions:
      - text: Create a setting template named {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Create {type} template {name} for site {site_id}.
        slots:
          type: requestBody.type
          name: requestBody.name
          site_id: requestBody.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/setting_templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a setting template's details
      effect: read
      questions:
      - What settings does a particular phone template define?
      - Can I fetch only certain fields of a setting template?
      instructions:
      - text: Show setting template {templateId}.
        slots:
          templateId: path.templateId
      - text: Get template {templateId} with fields {custom_query_fields}.
        slots:
          templateId: path.templateId
          custom_query_fields: query.custom_query_fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/setting_templates/{templateId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a phone setting template
      effect: write
      questions:
      - How do I change the policy or user settings in a phone template?
      - Can I rename an existing setting template?
      instructions:
      - text: Rename setting template {templateId} to {name}.
        slots:
          templateId: path.templateId
          name: requestBody.name
      - text: Update the user settings of template {templateId} to {user_settings}.
        slots:
          templateId: path.templateId
          user_settings: requestBody.user_settings
      method: generated
      generated: '2026-10-01'