Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Device Line Keys API

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

$.info

$.paths['/phone/devices/{deviceId}/line_keys'].get

$.paths['/phone/devices/{deviceId}/line_keys'].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 Device Line Keys API
  version: 1.0.0
extends: openapi/zoom-phone-device-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: 2
- target: $.paths['/phone/devices/{deviceId}/line_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a desk phone's line key layout
      effect: read
      questions:
      - Which line keys are set up on a shared desk phone, and in what positions?
      - Can I see how a multi-user device's keys are currently arranged?
      instructions:
      - text: Show the line key settings of device {deviceId}.
        slots:
          deviceId: path.deviceId
      - text: List the key positions on desk phone {deviceId}.
        slots:
          deviceId: path.deviceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/devices/{deviceId}/line_keys'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rearrange a desk phone's line key positions
      effect: write
      questions:
      - Can I reorder the line keys on a desk phone in one update?
      - Is it possible to move several line keys to new positions at the same time?
      instructions:
      - text: Update line key positions on device {deviceId} to {positions}.
        slots:
          deviceId: path.deviceId
          positions: requestBody.positions
      - text: Rearrange the keys on desk phone {deviceId}.
        slots:
          deviceId: path.deviceId
      method: generated
      generated: '2026-10-01'