# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Recordings API
  version: 1.0.0
extends: openapi/zoom-phone-recordings-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: 9
- target: $.paths['/phone/call_element/{callElementId}/recording'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the recording for a call element
      effect: read
      questions:
      - Can I fetch the recording attached to one specific leg of a call?
      - Is there a recording for a given call element ID?
      instructions:
      - text: Get the recording for call element {callElementId}.
        slots:
          callElementId: path.callElementId
      - text: Find the call recording on leg {callElementId}.
        slots:
          callElementId: path.callElementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_logs/{id}/recordings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recording by call ID or call log ID
      effect: read
      questions:
      - Can I find the recording and its file URL from a call ID or call log ID?
      - Where do I get a call recording when all I have is the call log entry?
      instructions:
      - text: Get the recording for call {id}.
        slots:
          id: path.id
      - text: Return the recording file URL for call log {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/recording/download/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a call recording file
      effect: read
      questions:
      - Can I download the audio file of a phone recording?
      - What do I need to save a call recording file locally?
      instructions:
      - text: Download recording file {fileId}.
        slots:
          fileId: path.fileId
      - text: Save the audio of recording file {fileId}.
        slots:
          fileId: path.fileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/recording_transcript/download/{recordingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a call recording transcript
      effect: read
      questions:
      - Can I get the text transcript of a recorded phone call?
      - Is a downloadable transcript available for a call recording?
      instructions:
      - text: Download the transcript of recording {recordingId}.
        slots:
          recordingId: path.recordingId
      - text: Get the text of recorded call {recordingId}.
        slots:
          recordingId: path.recordingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/recordings'].get
  update:
    x-apievangelist-phrasing:
      intent: List call recordings across the account
      effect: read
      questions:
      - Which calls were recorded across the company last month?
      - Can I filter account recordings by site, owner type or automatic vs on-demand?
      instructions:
      - text: List all account call recordings from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Show {recording_type} recordings at site {site_id}.
        slots:
          recording_type: query.recording_type
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/recordings/{recordingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a call recording
      effect: destructive
      questions:
      - Can I delete a call recording that shouldn't have been kept?
      - Is a deleted phone recording recoverable afterwards?
      instructions:
      - text: Delete call recording {recordingId}.
        slots:
          recordingId: path.recordingId
      - text: Remove recording {recordingId} from the account.
        slots:
          recordingId: path.recordingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/recordings/{recordingId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn auto delete on or off for a recording
      effect: write
      questions:
      - Can I exempt one recording from automatic deletion after the retention period?
      - Does changing a recording's auto delete flag require the retention setting to be on?
      instructions:
      - text: Set auto delete to {auto_delete_enable} on recording {recordingId}.
        slots:
          auto_delete_enable: requestBody.auto_delete_enable
          recordingId: path.recordingId
      - text: Keep recording {recordingId} past retention by disabling auto delete.
        slots:
          recordingId: path.recordingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/recordings/{recordingId}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Recover a recording from the trash
      effect: write
      questions:
      - Can I restore a call recording that was moved to the trash?
      - What status actions can I apply to a single recording?
      instructions:
      - text: Recover recording {recordingId} from the trash.
        slots:
          recordingId: path.recordingId
      - text: Apply status action {action} to recording {recordingId}.
        slots:
          action: requestBody.action
          recordingId: path.recordingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/recordings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's call recordings
      effect: read
      questions:
      - Which of a specific person's calls were recorded this month?
      - Can I list my own phone recordings in a date range?
      instructions:
      - text: List recordings for user {userId} from {from} to {to}.
        slots:
          userId: path.userId
          from: query.from
          to: query.to
      - text: Show all call recordings belonging to {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'