Zoom · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoom REST Device API

5 actions 5 updates phrasing extends openapi/zoom-device-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Zoom's API. It is a proposal applied on top of the contract, not a document Zoom publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/h323/device/create'].post
$.paths['/h323/device/delete'].post
$.paths['/h323/device/list'].post
$.paths['/h323/device/update'].post

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 Zoom REST Device API
  version: 1.0.0
extends: openapi/zoom-device-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/h323/device/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an H.323/SIP room device
      effect: write
      questions:
      - How do I register a H.323 or SIP conference room system with my account?
      - Can I choose the protocol and encryption when adding a room device?
      instructions:
      - text: Add H.323/SIP device {name} at IP {ip}.
        slots:
          name: requestBody.name
          ip: requestBody.ip
      - text: Register device {name} at {ip} using protocol {protocol_type} and encryption {encryption_type}.
        slots:
          name: requestBody.name
          ip: requestBody.ip
          protocol_type: requestBody.protocol_type
          encryption_type: requestBody.encryption_type
      method: generated
      generated: '2026-09-24'
- target: $.paths['/h323/device/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an H.323/SIP device
      effect: destructive
      questions:
      - Can I remove a SIP or H.323 device from the account?
      - What do I need to delete a room system device?
      instructions:
      - text: Delete H.323/SIP device {id}.
        slots:
          id: requestBody.id
      - text: Remove the room system device {id} from my account.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/h323/device/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List H.323/SIP devices
      effect: read
      questions:
      - Which H.323 and SIP devices are registered on my account?
      - Can I page through our room system devices?
      instructions:
      - text: List all H.323/SIP devices on my account.
      - text: Show page {page_number} of room system devices.
        slots:
          page_number: requestBody.page_number
      method: generated
      generated: '2026-09-24'
- target: $.paths['/h323/device/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an H.323/SIP device
      effect: write
      questions:
      - Can I change the IP address of a registered room device?
      - Is it possible to switch an existing device's encryption setting?
      instructions:
      - text: Change the IP of device {id} to {ip}.
        slots:
          id: requestBody.id
          ip: requestBody.ip
      - text: Set encryption on existing device {id} to {encryption_type}.
        slots:
          id: requestBody.id
          encryption_type: requestBody.encryption_type
      method: generated
      generated: '2026-09-24'