Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Audio Library API

7 actions 7 updates phrasing extends openapi/zoom-phone-audio-library-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/audios/{audioId}'].get

$.paths['/phone/audios/{audioId}'].delete

$.paths['/phone/audios/{audioId}'].patch

$.paths['/phone/users/{userId}/audios'].get

$.paths['/phone/users/{userId}/audios'].post

$.paths['/phone/users/{userId}/audios/batch'].post

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 Audio Library API
  version: 1.0.0
extends: openapi/zoom-phone-audio-library-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/audios/{audioId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audio library item
      effect: read
      questions:
      - What are the details of one audio file in my phone audio library?
      - Can I look up a greeting audio by its ID?
      instructions:
      - text: Show audio item {audioId}.
        slots:
          audioId: path.audioId
      - text: Get details of audio library item {audioId}.
        slots:
          audioId: path.audioId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/audios/{audioId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an audio library item
      effect: destructive
      questions:
      - Can I delete a greeting from my phone audio library?
      - What removes an audio item permanently?
      instructions:
      - text: Delete audio item {audioId}.
        slots:
          audioId: path.audioId
      - text: Remove audio {audioId} from the library.
        slots:
          audioId: path.audioId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/audios/{audioId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an audio library item
      effect: write
      questions:
      - How do I rename an audio file in the library?
      - Can I change the name of an existing greeting audio?
      instructions:
      - text: Rename audio item {audioId} to {name}.
        slots:
          audioId: path.audioId
          name: requestBody.name
      - text: Change audio {audioId}'s name to {name}.
        slots:
          audioId: path.audioId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/audios'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's audio library
      effect: read
      questions:
      - Which personal audio files does a user have?
      - Where can I see all greetings in my audio library?
      instructions:
      - text: List audio items for user {userId}.
        slots:
          userId: path.userId
      - text: Show every audio in user {userId}'s library.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/audios'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a text-to-speech audio item
      effect: write
      questions:
      - Can I generate a greeting from text instead of recording one?
      - Which voice language and accent can a text-to-speech audio use?
      instructions:
      - text: Create text-to-speech audio {audio_name} for user {userId} saying {text}.
        slots:
          audio_name: requestBody.audio_name
          userId: path.userId
          text: requestBody.text
      - text: Turn {text} into speech in {voice_language} for user {userId}.
        slots:
          text: requestBody.text
          voice_language: requestBody.voice_language
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/audios/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload voice files to the audio library
      effect: write
      questions:
      - How do I upload recorded voice files to a user's audio library?
      - What size and count limits apply when uploading audio attachments?
      instructions:
      - text: Upload audio files {attachments} for user {userId}.
        slots:
          attachments: requestBody.attachments
          userId: path.userId
      - text: Add recorded voice files to user {userId}'s audio library.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'