# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Group Call Pickup API
  version: 1.0.0
extends: openapi/zoom-phone-group-call-pickup-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/group_call_pickup'].get
  update:
    x-apievangelist-phrasing:
      intent: List group call pickup groups
      effect: read
      questions:
      - Which call pickup groups exist in my phone system?
      - Can I list group call pickup groups for just one site?
      instructions:
      - text: List all group call pickup groups.
      - text: Show call pickup groups at site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/group_call_pickup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group call pickup group
      effect: write
      questions:
      - How do I set up a group so coworkers can answer each other's ringing phones?
      - Can I enable directed call pickup or a ring delay when creating a pickup group?
      instructions:
      - text: Create a call pickup group named {display_name} at site {site_id}.
        slots:
          display_name: requestBody.display_name
          site_id: requestBody.site_id
      - text: Add pickup group {display_name} at site {site_id} with members {member_extension_ids}.
        slots:
          display_name: requestBody.display_name
          site_id: requestBody.site_id
          member_extension_ids: requestBody.member_extension_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/group_call_pickup/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group call pickup group
      effect: read
      questions:
      - What extension, delay and sound settings does a pickup group have?
      - Can I look up one call pickup group by its ID?
      instructions:
      - text: Get call pickup group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show the settings of pickup group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/group_call_pickup/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group call pickup group
      effect: destructive
      questions:
      - Can I remove a call pickup group we no longer need?
      - Is deleting a pickup group permanent?
      instructions:
      - text: Delete call pickup group {groupId}.
        slots:
          groupId: path.groupId
      - text: Remove pickup group {groupId} from the account.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/group_call_pickup/{groupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group call pickup group
      effect: write
      questions:
      - Can I rename a pickup group or change its extension number?
      - Is it possible to change the pickup delay or turn off the incoming call sound?
      instructions:
      - text: Rename pickup group {groupId} to {display_name}.
        slots:
          groupId: path.groupId
          display_name: requestBody.display_name
      - text: Set the pickup delay of group {groupId} to {delay}.
        slots:
          groupId: path.groupId
          delay: requestBody.delay
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/group_call_pickup/{groupId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a call pickup group
      effect: read
      questions:
      - Who is in a particular call pickup group?
      - Can I filter pickup group members by extension type?
      instructions:
      - text: List members of pickup group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show {extension_type} members in pickup group {groupId}.
        slots:
          extension_type: query.extension_type
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/group_call_pickup/{groupId}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to a call pickup group
      effect: write
      questions:
      - Can I add new teammates to an existing call pickup group?
      - Is there a way to add several extensions to a pickup group at once?
      instructions:
      - text: Add extensions {member_extension_ids} to pickup group {groupId}.
        slots:
          member_extension_ids: requestBody.member_extension_ids
          groupId: path.groupId
      - text: 'Put these extensions into call pickup group {groupId}: {member_extension_ids}.'
        slots:
          groupId: path.groupId
          member_extension_ids: requestBody.member_extension_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/group_call_pickup/{groupId}/members/{extensionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from a call pickup group
      effect: destructive
      questions:
      - Can I take one person out of a call pickup group?
      - What do I need to remove an extension from a pickup group?
      instructions:
      - text: Remove extension {extensionId} from pickup group {groupId}.
        slots:
          extensionId: path.extensionId
          groupId: path.groupId
      - text: Take member {extensionId} out of call pickup group {groupId}.
        slots:
          extensionId: path.extensionId
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'