Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Groups API

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

$.info
$.paths['/phone/groups/{groupId}/policies/{policyType}'].get
$.paths['/phone/groups/{groupId}/policies/{policyType}'].patch
$.paths['/phone/groups/{groupId}/settings'].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 Groups API
  version: 1.0.0
extends: openapi/zoom-phone-groups-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: 3
- target: $.paths['/phone/groups/{groupId}/policies/{policyType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's phone policy
      effect: read
      questions:
      - What Zoom Phone policy applies to a particular user group?
      - Can I read one policy type for a group?
      instructions:
      - text: Show the {policyType} policy for group {groupId}.
        slots:
          groupId: path.groupId
          policyType: path.policyType
      - text: Get group {groupId}'s {policyType} policy details.
        slots:
          groupId: path.groupId
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/groups/{groupId}/policies/{policyType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group's phone policy
      effect: write
      questions:
      - How do I change a Zoom Phone policy for one group of users?
      - Can a group override the account's phone policy?
      instructions:
      - text: Update the {policyType} policy for group {groupId}.
        slots:
          groupId: path.groupId
          policyType: path.policyType
      - text: Change group {groupId}'s {policyType} phone policy.
        slots:
          groupId: path.groupId
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/groups/{groupId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's phone settings
      effect: read
      questions:
      - What phone settings does a user group have?
      - Can I fetch only certain setting types for a group?
      instructions:
      - text: Show the phone settings of group {groupId}.
        slots:
          groupId: path.groupId
      - text: Get group {groupId} phone settings of types {setting_types}.
        slots:
          groupId: path.groupId
          setting_types: query.setting_types
      method: generated
      generated: '2026-10-01'