# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Call Logs API
  version: 1.0.0
extends: openapi/zoom-phone-call-logs-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: 15
- target: $.paths['/phone/call_element/{callElementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a call element by ID
      effect: read
      questions:
      - Can I look up a single call element, one leg of a call, by its ID?
      - What details does a call element hold for one segment of a phone call?
      instructions:
      - text: Get call element {callElementId}.
        slots:
          callElementId: path.callElementId
      - text: Show the call leg recorded as call element {callElementId}.
        slots:
          callElementId: path.callElementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_history'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's call history (new edition)
      effect: read
      questions:
      - Which calls across the whole company went unanswered or to voicemail last month?
      - Can I filter account-wide call history by direction, site, department or recording status?
      - Is there a way to search all company call history by name, number or call ID?
      instructions:
      - text: List the account's call history from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Search company call history for {keyword}.
        slots:
          keyword: query.keyword
      - text: Show account call history for sites {site_ids} that has recordings ({recording_status}).
        slots:
          site_ids: query.site_ids
          recording_status: query.recording_status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_history/{callHistoryUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one call history record by UUID
      effect: read
      questions:
      - Can I see the full path a call took, every hop, from its call history UUID?
      - What information is in a single call history entry in the new call log edition?
      instructions:
      - text: Get call history {callHistoryUuid}.
        slots:
          callHistoryUuid: path.callHistoryUuid
      - text: Show how call {callHistoryUuid} was routed.
        slots:
          callHistoryUuid: path.callHistoryUuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_history/{callLogId}/client_code'].patch
  update:
    x-apievangelist-phrasing:
      intent: Tag a call history record with a client code
      effect: write
      questions:
      - Can I attach a billing client code to a call in the new call history?
      - How long can a client code be when I mark a call history record?
      instructions:
      - text: Add client code {client_code} to call history record {callLogId}.
        slots:
          client_code: requestBody.client_code
          callLogId: path.callLogId
      - text: Mark call history {callLogId} with client code {client_code} for billing.
        slots:
          callLogId: path.callLogId
          client_code: requestBody.client_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_history_detail/{callHistoryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get call history detail by call history ID
      effect: read
      questions:
      - Where do I get the detailed breakdown of a call history entry by its ID?
      - Can I fetch the call history detail record for one specific call?
      instructions:
      - text: Get the call history detail for {callHistoryId}.
        slots:
          callHistoryId: path.callHistoryId
      - text: Show the detailed record of call history {callHistoryId}.
        slots:
          callHistoryId: path.callHistoryId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's call logs (older edition)
      effect: read
      questions:
      - Can I pull every missed call in the account from the older call logs endpoint?
      - Is there a way to list only account call logs that incurred a charge?
      instructions:
      - text: List the account's {type} call logs from {from} to {to}.
        slots:
          type: query.type
          from: query.from
          to: query.to
      - text: Show account call logs for site {site_id} with charged-only set to {charged_call_logs}.
        slots:
          site_id: query.site_id
          charged_call_logs: query.charged_call_logs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_logs/{callLogId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get call log details (older edition)
      effect: read
      questions:
      - Can I retrieve a single call log from the older call logs edition?
      - What caller, callee and duration info is stored on one call log?
      instructions:
      - text: Get call log {callLogId}.
        slots:
          callLogId: path.callLogId
      - text: Show caller, callee and duration for call log {callLogId}.
        slots:
          callLogId: path.callLogId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_logs/{callLogId}/client_code'].put
  update:
    x-apievangelist-phrasing:
      intent: Tag a call log with a client code (older edition)
      effect: write
      questions:
      - Can I add a client code to a call in the older call logs edition?
      - Is it possible to track legacy call logs by client code?
      instructions:
      - text: Add client code {client_code} to legacy call log {callLogId}.
        slots:
          client_code: requestBody.client_code
          callLogId: path.callLogId
      - text: Set the client code on old-edition call log {callLogId} to {client_code}.
        slots:
          callLogId: path.callLogId
          client_code: requestBody.client_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/user/{userId}/ai_call_summary/{aiCallSummaryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's AI call summary
      effect: read
      questions:
      - Can I read the AI-generated summary of a user's phone call?
      - Where do I fetch AI call summary details for a specific call?
      instructions:
      - text: Get AI call summary {aiCallSummaryId} for user {userId}.
        slots:
          aiCallSummaryId: path.aiCallSummaryId
          userId: path.userId
      - text: Show user {userId} the AI summary {aiCallSummaryId} of their call.
        slots:
          aiCallSummaryId: path.aiCallSummaryId
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/call_history'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's call history (new edition)
      effect: read
      questions:
      - Which calls did a specific person make or receive last week?
      - Can I filter one user's call history to only calls with voicemail or recordings?
      instructions:
      - text: List call history for user {userId} from {from} to {to}.
        slots:
          userId: path.userId
          from: query.from
          to: query.to
      - text: Search user {userId}'s call history for {keyword}.
        slots:
          userId: path.userId
          keyword: query.keyword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/call_history/sync'].get
  update:
    x-apievangelist-phrasing:
      intent: Sync a user's call history incrementally
      effect: read
      questions:
      - Can I keep a local copy of a user's call history up to date with a sync token?
      - What sync modes, full, incremental or backward, are supported for call history?
      instructions:
      - text: Run a {sync_type} sync of user {userId}'s call history.
        slots:
          sync_type: query.sync_type
          userId: path.userId
      - text: Continue syncing {userId}'s call history from token {sync_token}.
        slots:
          userId: path.userId
          sync_token: query.sync_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/call_history/{callLogId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a call from a user's call history
      effect: destructive
      questions:
      - Can I permanently remove one call from a user's new-edition call history?
      - Is deleting a user's call history entry reversible?
      instructions:
      - text: Delete call history entry {callLogId} for user {userId}.
        slots:
          callLogId: path.callLogId
          userId: path.userId
      - text: Remove call {callLogId} from {userId}'s call history.
        slots:
          callLogId: path.callLogId
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/call_logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's call logs (older edition)
      effect: read
      questions:
      - Can I list only the missed calls for one user from the legacy call logs?
      - Is there a way to filter a user's old-edition call logs by phone number?
      instructions:
      - text: List legacy call logs for user {userId} from {from} to {to}.
        slots:
          userId: path.userId
          from: query.from
          to: query.to
      - text: Show {userId}'s old-edition call logs with number {phone_number}.
        slots:
          userId: path.userId
          phone_number: query.phone_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/call_logs/sync'].get
  update:
    x-apievangelist-phrasing:
      intent: Sync a user's call logs (older edition)
      effect: read
      questions:
      - Can I incrementally sync a user's legacy call logs instead of re-reading them all?
      - How many records come back per page when syncing old-edition call logs?
      instructions:
      - text: Do a {sync_type} sync of user {userId}'s legacy call logs.
        slots:
          sync_type: query.sync_type
          userId: path.userId
      - text: Fetch {count} more legacy call logs for {userId} from sync token {sync_token}.
        slots:
          count: query.count
          userId: path.userId
          sync_token: query.sync_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/call_logs/{callLogId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's call log (older edition)
      effect: destructive
      questions:
      - Can I delete a single legacy call log from a user's list?
      - Where do I get the call log ID needed to remove an old-edition call log?
      instructions:
      - text: Delete legacy call log {callLogId} for user {userId}.
        slots:
          callLogId: path.callLogId
          userId: path.userId
      - text: Remove old-edition call log {callLogId} from {userId}.
        slots:
          callLogId: path.callLogId
          userId: path.userId
      method: generated
      generated: '2026-10-01'