# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Voicemails API
  version: 1.0.0
extends: openapi/zoom-phone-voicemails-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: 8
- target: $.paths['/phone/call_element/{callElementId}/voice_mail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a voicemail by call element
      effect: read
      questions:
      - Can I find the voicemail left during a specific call element?
      - Which voicemail is tied to a given call element ID?
      instructions:
      - text: Show the voicemail for call element {callElementId}.
        slots:
          callElementId: path.callElementId
      - text: Get voicemail details for call element {callElementId}.
        slots:
          callElementId: path.callElementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/call_logs/{id}/voice_mail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the voicemail from a user's call log
      effect: read
      questions:
      - Did a caller leave a voicemail on a call in my call history?
      - How do I get the voicemail tied to one of a user's call log entries?
      instructions:
      - text: Show the voicemail from call log {id} for user {userId}.
        slots:
          id: path.id
          userId: path.userId
      - text: Get the voicemail left on my call log entry {id}.
        slots:
          id: path.id
      - text: Fetch voicemail details for user {userId}'s call {id}.
        slots:
          userId: path.userId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/voice_mails'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's voicemails
      effect: read
      questions:
      - What voicemails are in a user's mailbox?
      - Can I list only unread voicemails or ones in the trash for a user?
      instructions:
      - text: List voicemails for user {userId}.
        slots:
          userId: path.userId
      - text: List user {userId}'s {status} voicemails from {from} to {to}.
        slots:
          userId: path.userId
          status: query.status
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/voice_mails'].get
  update:
    x-apievangelist-phrasing:
      intent: List voicemails across the account
      effect: read
      questions:
      - Which voicemails have been left anywhere on the account?
      - Can I filter account voicemails by site, owner type or status?
      instructions:
      - text: List all voicemails on the account.
      - text: List account voicemails at site {site_id} with status {status}.
        slots:
          site_id: query.site_id
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/voice_mails/download/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a voicemail audio file
      effect: read
      questions:
      - How do I download the audio of a voicemail?
      - Can I save a voicemail recording as a file?
      instructions:
      - text: Download voicemail file {fileId}.
        slots:
          fileId: path.fileId
      - text: Save the voicemail audio {fileId}.
        slots:
          fileId: path.fileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/voice_mails/{voicemailId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a voicemail's details
      effect: read
      questions:
      - What are the details of one voicemail message?
      - Where do I see who left a particular voicemail and when?
      instructions:
      - text: Show voicemail {voicemailId}.
        slots:
          voicemailId: path.voicemailId
      - text: Get the caller and time of voicemail {voicemailId}.
        slots:
          voicemailId: path.voicemailId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/voice_mails/{voicemailId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a voicemail
      effect: destructive
      questions:
      - Can I delete a voicemail message from the account?
      - What permanently removes one voicemail?
      instructions:
      - text: Delete voicemail {voicemailId}.
        slots:
          voicemailId: path.voicemailId
      - text: Remove voicemail message {voicemailId}.
        slots:
          voicemailId: path.voicemailId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/voice_mails/{voicemailId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark a voicemail as read or unread
      effect: write
      questions:
      - How do I mark a voicemail as read?
      - Can a listened voicemail be set back to unread?
      instructions:
      - text: Mark voicemail {voicemailId} as {read_status}.
        slots:
          voicemailId: path.voicemailId
          read_status: query.read_status
      - text: Set the read status of voicemail {voicemailId} to {read_status}.
        slots:
          voicemailId: path.voicemailId
          read_status: query.read_status
      method: generated
      generated: '2026-10-01'