Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone IVR API

3 actions 3 updates phrasing extends openapi/zoom-phone-ivr-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/auto_receptionists/{autoReceptionistId}/ivr'].get

$.paths['/phone/auto_receptionists/{autoReceptionistId}/ivr'].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 IVR API
  version: 1.0.0
extends: openapi/zoom-phone-ivr-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/auto_receptionists/{autoReceptionistId}/ivr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an auto receptionist's IVR menu
      effect: read
      questions:
      - What key-press options does our main auto receptionist offer?
      - Can I see the IVR menu used during holiday hours?
      instructions:
      - text: Show the IVR of auto receptionist {autoReceptionistId}.
        slots:
          autoReceptionistId: path.autoReceptionistId
      - text: Show auto receptionist {autoReceptionistId}'s IVR for {hours_type} hours.
        slots:
          autoReceptionistId: path.autoReceptionistId
          hours_type: query.hours_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/auto_receptionists/{autoReceptionistId}/ivr'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an auto receptionist's IVR menu
      effect: write
      questions:
      - How do I change what pressing a key does in our phone menu?
      - Can callers be allowed to dial an extension directly from the IVR?
      instructions:
      - text: Update the IVR key action of auto receptionist {autoReceptionistId} to {key_action}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          key_action: requestBody.key_action
      - text: Set the IVR prompt of auto receptionist {autoReceptionistId} to audio {audio_prompt_id}.
        slots:
          autoReceptionistId: path.autoReceptionistId
          audio_prompt_id: requestBody.audio_prompt_id
      method: generated
      generated: '2026-10-01'