Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Dial by Name Directory API

7 actions 7 updates phrasing extends openapi/zoom-phone-dial-by-name-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 7

$.info
$.paths['/phone/dial_by_name_directory/extensions'].get
$.paths['/phone/dial_by_name_directory/extensions'].post
$.paths['/phone/dial_by_name_directory/extensions'].delete
$.paths['/phone/sites/{siteId}/dial_by_name_directory/extensions'].get
$.paths['/phone/sites/{siteId}/dial_by_name_directory/extensions'].post
$.paths['/phone/sites/{siteId}/dial_by_name_directory/extensions'].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 Dial by Name Directory API
  version: 1.0.0
extends: openapi/zoom-phone-dial-by-name-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: 6
- target: $.paths['/phone/dial_by_name_directory/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in or out of the dial-by-name directory
      effect: read
      questions:
      - Which users can callers reach by spelling their name in the directory?
      - Can I see who is not yet in the dial-by-name directory for a site?
      instructions:
      - text: List dial-by-name directory users for site {site_id}.
        slots:
          site_id: query.site_id
      - text: Show users at site {site_id} with in-directory set to {in_directory}.
        slots:
          site_id: query.site_id
          in_directory: query.in_directory
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/dial_by_name_directory/extensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users to the dial-by-name directory
      effect: write
      questions:
      - Can I make new employees reachable through the dial-by-name directory?
      - Is it possible to add several extensions to the directory in one call?
      instructions:
      - text: Add extensions {extension_ids} to the dial-by-name directory for site {site_id}.
        slots:
          extension_ids: requestBody.extension_ids
          site_id: requestBody.site_id
      - text: Put users into the site {site_id} name directory.
        slots:
          site_id: requestBody.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/dial_by_name_directory/extensions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove users from the dial-by-name directory
      effect: destructive
      questions:
      - Can I hide someone from the dial-by-name directory?
      - What do I pass to remove extensions from the name directory?
      instructions:
      - text: Remove extensions {extension_ids} from the dial-by-name directory of site {site_id}.
        slots:
          extension_ids: query.extension_ids
          site_id: query.site_id
      - text: Delete users from the name directory for site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/dial_by_name_directory/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List directory users via the site path
      effect: read
      questions:
      - Can I list a site's dial-by-name directory members using the site-scoped endpoint?
      - Which users are in the directory under a given site path?
      instructions:
      - text: List directory users under site path {siteId}.
        slots:
          siteId: path.siteId
      - text: Show users not in the name directory for site path {siteId} where in_directory is {in_directory}.
        slots:
          siteId: path.siteId
          in_directory: query.in_directory
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/dial_by_name_directory/extensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users to a site's directory via the site path
      effect: write
      questions:
      - Can I add extensions to a specific site's name directory through the site-scoped endpoint?
      - Is there a site-path version of adding users to the dial-by-name directory?
      instructions:
      - text: Add extensions {extension_ids} to the directory under site path {siteId}.
        slots:
          extension_ids: requestBody.extension_ids
          siteId: path.siteId
      - text: Enroll users in the name directory of site path {siteId}.
        slots:
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/dial_by_name_directory/extensions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove users from a site's directory via the site path
      effect: destructive
      questions:
      - Can I remove extensions from a site's name directory using the site-scoped endpoint?
      - Is there a site-path way to take users out of the dial-by-name directory?
      instructions:
      - text: Remove extensions {extension_ids} from the directory under site path {siteId}.
        slots:
          extension_ids: query.extension_ids
          siteId: path.siteId
      - text: Take users out of the name directory of site path {siteId}.
        slots:
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'