Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Private Directory API

5 actions 5 updates phrasing extends openapi/zoom-phone-private-directory-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/private_directory/members'].get

$.paths['/phone/private_directory/members'].post

$.paths['/phone/private_directory/members/{extensionId}'].delete

$.paths['/phone/private_directory/members/{extensionId}'].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 Private Directory API
  version: 1.0.0
extends: openapi/zoom-phone-private-directory-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/private_directory/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List private directory members
      effect: read
      questions:
      - Who is hidden in our private phone directory?
      - Can I search private directory members by keyword or site?
      instructions:
      - text: List the private directory members.
      - text: Search private directory members for {keyword}.
        slots:
          keyword: query.keyword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/private_directory/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to the private directory
      effect: write
      questions:
      - How do I hide executives' extensions in a private directory?
      - Can I add private directory members for a single site?
      instructions:
      - text: Add {members} to the private directory.
        slots:
          members: requestBody.members
      - text: Add {members} to the private directory at site {site_id}.
        slots:
          members: requestBody.members
          site_id: requestBody.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/private_directory/members/{extensionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from the private directory
      effect: destructive
      questions:
      - Can I take someone out of the private directory?
      - Does removing an extension from the private directory make it visible again?
      instructions:
      - text: Remove extension {extensionId} from the private directory.
        slots:
          extensionId: path.extensionId
      - text: Remove extension {extensionId} from site {site_id}'s private directory.
        slots:
          extensionId: path.extensionId
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/private_directory/members/{extensionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a private member's web portal visibility
      effect: write
      questions:
      - Can a private directory member still be searchable on the web portal?
      - How do I change whether a private member shows in web portal search?
      instructions:
      - text: Set extension {extensionId} searchable on web portal to {searchable_on_web_portal}.
        slots:
          extensionId: path.extensionId
          searchable_on_web_portal: requestBody.searchable_on_web_portal
      - text: Update private member {extensionId} web portal search visibility to {searchable_on_web_portal}.
        slots:
          extensionId: path.extensionId
          searchable_on_web_portal: requestBody.searchable_on_web_portal
      method: generated
      generated: '2026-10-01'