Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Zoom Rooms API

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

$.info
$.paths['/phone/rooms'].get
$.paths['/phone/rooms'].post
$.paths['/phone/rooms/unassigned'].get
$.paths['/phone/rooms/{roomId}'].get
$.paths['/phone/rooms/{roomId}'].delete
$.paths['/phone/rooms/{roomId}'].patch
$.paths['/phone/rooms/{roomId}/calling_plans'].post
$.paths['/phone/rooms/{roomId}/calling_plans/{type}'].delete
$.paths['/phone/rooms/{roomId}/phone_numbers'].post
$.paths['/phone/rooms/{roomId}/phone_numbers/{phoneNumberId}'].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 Zoom Rooms API
  version: 1.0.0
extends: openapi/zoom-phone-zoom-rooms-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: 10
- target: $.paths['/phone/rooms'].get
  update:
    x-apievangelist-phrasing:
      intent: List Zoom Rooms with a Zoom Phone license
      effect: read
      questions:
      - Which Zoom Rooms already have Zoom Phone enabled?
      - Can I filter phone-enabled Zoom Rooms by site or calling type?
      instructions:
      - text: List Zoom Rooms that have a Zoom Phone license.
      - text: List phone-enabled Zoom Rooms at site {site_id} matching {keyword}.
        slots:
          site_id: query.site_id
          keyword: query.keyword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Zoom Room to Zoom Phone
      effect: write
      questions:
      - How do I turn on Zoom Phone for a conference room?
      - Can I assign calling plans while adding a Zoom Room to Zoom Phone?
      instructions:
      - text: Add Zoom Room {id} to Zoom Phone.
        slots:
          id: requestBody.id
      - text: Add Zoom Room {id} to Zoom Phone at site {site_id} with calling plans {calling_plans}.
        slots:
          id: requestBody.id
          site_id: requestBody.site_id
          calling_plans: requestBody.calling_plans
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms/unassigned'].get
  update:
    x-apievangelist-phrasing:
      intent: List Zoom Rooms without Zoom Phone
      effect: read
      questions:
      - Which Zoom Rooms don't have a phone assigned yet?
      - Can I search rooms that are missing Zoom Phone by name?
      instructions:
      - text: List Zoom Rooms that are not assigned Zoom Phone.
      - text: Find unassigned Zoom Rooms matching {keyword}.
        slots:
          keyword: query.keyword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms/{roomId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Zoom Room's phone setup
      effect: read
      questions:
      - What extension, numbers and calling plans does a Zoom Room have?
      - Can I look up the Zoom Phone details of one conference room?
      instructions:
      - text: Show the Zoom Phone details of room {roomId}.
        slots:
          roomId: path.roomId
      - text: Get Zoom Room {roomId}'s extension and calling plans.
        slots:
          roomId: path.roomId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms/{roomId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a Zoom Room from Zoom Phone
      effect: destructive
      questions:
      - How do I turn off Zoom Phone for a conference room?
      - Can I disconnect a Zoom Room from the Zoom Phone account?
      instructions:
      - text: Remove Zoom Room {roomId} from Zoom Phone.
        slots:
          roomId: path.roomId
      - text: Disconnect room {roomId} from the Zoom Phone account.
        slots:
          roomId: path.roomId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms/{roomId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Zoom Room's phone settings
      effect: write
      questions:
      - How do I change a Zoom Room's phone extension?
      - Can I move a phone-enabled Zoom Room to another site?
      instructions:
      - text: Set Zoom Room {roomId}'s extension to {extension_number}.
        slots:
          roomId: path.roomId
          extension_number: requestBody.extension_number
      - text: Move Zoom Room {roomId} to site {site_id}.
        slots:
          roomId: path.roomId
          site_id: requestBody.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms/{roomId}/calling_plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign calling plans to a Zoom Room
      effect: write
      questions:
      - How do I give a conference room an international calling plan?
      - Is there a limit on how many calling plans a Zoom Room can hold?
      instructions:
      - text: Assign calling plans {calling_plans} to Zoom Room {roomId}.
        slots:
          roomId: path.roomId
          calling_plans: requestBody.calling_plans
      - text: Add a calling plan to room {roomId}.
        slots:
          roomId: path.roomId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms/{roomId}/calling_plans/{type}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a calling plan from a Zoom Room
      effect: destructive
      questions:
      - How do I take a calling plan off a Zoom Room?
      - Can I specify which billing account when removing a room's calling plan?
      instructions:
      - text: Remove calling plan {type} from Zoom Room {roomId}.
        slots:
          roomId: path.roomId
          type: path.type
      - text: Unassign plan {type} from room {roomId} under billing account {billing_account_id}.
        slots:
          roomId: path.roomId
          type: path.type
          billing_account_id: query.billing_account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms/{roomId}/phone_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign phone numbers to a Zoom Room
      effect: write
      questions:
      - How do I give a conference room its own direct phone number?
      - How many numbers can I assign to a Zoom Room at once?
      instructions:
      - text: Assign {phone_numbers} to Zoom Room {roomId}.
        slots:
          roomId: path.roomId
          phone_numbers: requestBody.phone_numbers
      - text: Give room {roomId} a direct phone number.
        slots:
          roomId: path.roomId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/rooms/{roomId}/phone_numbers/{phoneNumberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a phone number from a Zoom Room
      effect: destructive
      questions:
      - How do I take a phone number off a Zoom Room?
      - Can I free up one number assigned to a conference room?
      instructions:
      - text: Remove phone number {phoneNumberId} from Zoom Room {roomId}.
        slots:
          roomId: path.roomId
          phoneNumberId: path.phoneNumberId
      - text: Unassign number {phoneNumberId} from room {roomId}.
        slots:
          roomId: path.roomId
          phoneNumberId: path.phoneNumberId
      method: generated
      generated: '2026-10-01'