Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Line Keys API

4 actions 4 updates phrasing extends openapi/zoom-phone-line-keys-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/extension/{extensionId}/line_keys'].get
$.paths['/phone/extension/{extensionId}/line_keys'].patch
$.paths['/phone/extension/{extensionId}/line_keys/{lineKeyId}'].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 Line Keys API
  version: 1.0.0
extends: openapi/zoom-phone-line-keys-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/extension/{extensionId}/line_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an extension's line key layout
      effect: read
      questions:
      - What is assigned to each line key on a user's desk phone?
      - Can I see line key positions for an extension?
      instructions:
      - text: Show the line key settings for extension {extensionId}.
        slots:
          extensionId: path.extensionId
      - text: List the line key positions of extension {extensionId}.
        slots:
          extensionId: path.extensionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/extension/{extensionId}/line_keys'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rearrange an extension's line keys
      effect: write
      questions:
      - How do I change the order of line keys on a desk phone?
      - Can I update several line keys at once?
      instructions:
      - text: Update line keys {line_keys} for extension {extensionId}.
        slots:
          line_keys: requestBody.line_keys
          extensionId: path.extensionId
      - text: Batch reposition extension {extensionId}'s line keys.
        slots:
          extensionId: path.extensionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/extension/{extensionId}/line_keys/{lineKeyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a line key
      effect: destructive
      questions:
      - Can I remove a single line key from a desk phone?
      - What deletes one line key setting from an extension?
      instructions:
      - text: Delete line key {lineKeyId} from extension {extensionId}.
        slots:
          lineKeyId: path.lineKeyId
          extensionId: path.extensionId
      - text: Remove line key {lineKeyId} on extension {extensionId}.
        slots:
          lineKeyId: path.lineKeyId
          extensionId: path.extensionId
      method: generated
      generated: '2026-10-01'