Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Call Queues API

33 actions 33 updates phrasing extends openapi/zoom-phone-call-queues-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 33 · first 16 shown; the file carries all of them

$.info
$.paths['/phone/call_queue_analytics'].get
$.paths['/phone/call_queues'].get
$.paths['/phone/call_queues'].post
$.paths['/phone/call_queues/{callQueueId}'].get
$.paths['/phone/call_queues/{callQueueId}'].delete
$.paths['/phone/call_queues/{callQueueId}'].patch
$.paths['/phone/call_queues/{callQueueId}/call_handling/settings'].get
$.paths['/phone/call_queues/{callQueueId}/call_handling/settings/{hourType}'].patch
$.paths['/phone/call_queues/{callQueueId}/custom_groups'].get
$.paths['/phone/call_queues/{callQueueId}/custom_groups'].post
$.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}'].get
$.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}'].delete
$.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}'].patch
$.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members'].post
$.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members/{extensionId}'].delete

OpenAPI Overlay

Raw ↑
# 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 Queues API
  version: 1.0.0
extends: openapi/zoom-phone-call-queues-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: 32
- target: $.paths['/phone/call_queue_analytics'].get
  update:
    x-apievangelist-phrasing:
      intent: Report call queue analytics for a date range
      effect: read
      questions:
      - What does the call queue analytics overview show for last month?
      - Can I narrow call queue analytics to one site, department or cost center?
      - Which queue extensions can I pick out when pulling queue performance stats?
      instructions:
      - text: Show call queue analytics from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Pull call queue analytics from {from} to {to} for site {site_id} only.
        slots:
          from: query.from
          to: query.to
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues'].get
  update:
    x-apievangelist-phrasing:
      intent: List the call queues on the account
      effect: read
      questions:
      - Which call queues are set up in our Zoom Phone account?
      - Can I list only the call queues that belong to one department?
      instructions:
      - text: List all call queues on the account.
      - text: List the call queues at site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a call queue
      effect: write
      questions:
      - How do I set up a new call queue for our sales team?
      - Can I give a new call queue its own extension number when I create it?
      instructions:
      - text: Create a call queue named {name} at site {site_id}.
        slots:
          name: requestBody.name
          site_id: requestBody.site_id
      - text: Create call queue {name} at site {site_id} with extension {extension_number}.
        slots:
          name: requestBody.name
          site_id: requestBody.site_id
          extension_number: requestBody.extension_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a call queue's details
      effect: read
      questions:
      - What extension and members does a specific call queue have?
      - Where can I look up the full configuration of one call queue?
      instructions:
      - text: Show details for call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Look up call queue {callQueueId} and tell me its extension number.
        slots:
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a call queue
      effect: destructive
      questions:
      - Can I permanently remove a call queue we no longer use?
      - What happens when I delete a call queue entirely?
      instructions:
      - text: Delete call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Remove the call queue {callQueueId} from the account.
        slots:
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a call queue's profile
      effect: write
      questions:
      - How do I rename a call queue or change its extension?
      - Can I change a call queue's time zone or set it inactive?
      - Is it possible to change where a queue's call recordings are stored?
      instructions:
      - text: Rename call queue {callQueueId} to {name}.
        slots:
          callQueueId: path.callQueueId
          name: requestBody.name
      - text: Set the status of call queue {callQueueId} to {status}.
        slots:
          callQueueId: path.callQueueId
          status: requestBody.status
      - text: Change the time zone of call queue {callQueueId} to {timezone}.
        slots:
          callQueueId: path.callQueueId
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/call_handling/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a call queue's call handling for an hour type
      effect: read
      questions:
      - What happens to calls into a queue after business hours?
      - Can I see a call queue's greeting and call distribution for holiday hours?
      instructions:
      - text: Show the call handling setting of call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Show call queue {callQueueId}'s call handling for {hour_type} hours.
        slots:
          callQueueId: path.callQueueId
          hour_type: query.hour_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/call_handling/settings/{hourType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a call queue's call handling for an hour type
      effect: write
      questions:
      - How do I change the way a call queue distributes calls during business hours?
      - Can I update a queue's greeting for closed hours without touching other fields?
      instructions:
      - text: Update call queue {callQueueId}'s call handling for {hourType} hours.
        slots:
          callQueueId: path.callQueueId
          hourType: path.hourType
      - text: Change the call distribution of call queue {callQueueId} during {hourType} hours to {call_distribution_setting}.
        slots:
          callQueueId: path.callQueueId
          hourType: path.hourType
          call_distribution_setting: requestBody.call_distribution_setting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/custom_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List a call queue's custom groups
      effect: read
      questions:
      - Which custom groups have been defined inside a call queue?
      - Can I see the subgroups of agents set up in one queue?
      instructions:
      - text: List the custom groups in call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Show me every custom group set up under queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/custom_groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom group in a call queue
      effect: write
      questions:
      - How do I split a call queue's members into a named custom group?
      - Can I add queue members to a custom group at the moment I create it?
      instructions:
      - text: Create a custom group named {name} in call queue {callQueueId}.
        slots:
          name: requestBody.name
          callQueueId: path.callQueueId
      - text: Create custom group {name} in call queue {callQueueId} with members {member_extension_ids}.
        slots:
          name: requestBody.name
          callQueueId: path.callQueueId
          member_extension_ids: requestBody.member_extension_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a call queue custom group
      effect: read
      questions:
      - What does a particular custom group in a call queue contain?
      - Where do I see the name and members of one queue custom group?
      instructions:
      - text: Show custom group {customGroupId} in call queue {callQueueId}.
        slots:
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
      - text: Get the name and members of queue {callQueueId} custom group {customGroupId}.
        slots:
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a call queue custom group
      effect: destructive
      questions:
      - Can I remove a custom group from a call queue altogether?
      - Does deleting a queue custom group get rid of the whole group, not just a member?
      instructions:
      - text: Delete custom group {customGroupId} from call queue {callQueueId}.
        slots:
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
      - text: Remove the whole custom group {customGroupId} from queue {callQueueId}.
        slots:
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a queue custom group
      effect: write
      questions:
      - How do I rename a custom group inside a call queue?
      - Can I change the description of an existing queue custom group?
      instructions:
      - text: Rename custom group {customGroupId} in call queue {callQueueId} to {name}.
        slots:
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
          name: requestBody.name
      - text: Set the description of custom group {customGroupId} in queue {callQueueId} to {description}.
        slots:
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add queue members to a custom group
      effect: write
      questions:
      - Can I add more queue members to an existing custom group?
      - How are agents added to a custom group after it already exists?
      instructions:
      - text: Add extensions {member_extension_ids} to custom group {customGroupId} in call queue {callQueueId}.
        slots:
          member_extension_ids: requestBody.member_extension_ids
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
      - text: Put queue {callQueueId} members {member_extension_ids} into existing custom group {customGroupId}.
        slots:
          member_extension_ids: requestBody.member_extension_ids
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members/{extensionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from a queue custom group
      effect: destructive
      questions:
      - Can I take one agent out of a custom group without removing them from the queue?
      - What removes a single extension from a call queue's custom group?
      instructions:
      - text: Remove extension {extensionId} from custom group {customGroupId} in call queue {callQueueId}.
        slots:
          extensionId: path.extensionId
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
      - text: Take extension {extensionId} out of queue {callQueueId} custom group {customGroupId} but keep it in the queue.
        slots:
          extensionId: path.extensionId
          customGroupId: path.customGroupId
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List a call queue's members
      effect: read
      questions:
      - Who are the agents answering calls in a given call queue?
      - Can I see which users and common areas belong to a queue?
      instructions:
      - text: List the members of call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Who answers calls in queue {callQueueId}? List its users and common areas.
        slots:
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users or common areas to a call queue
      effect: write
      questions:
      - How do I add phone users to an existing call queue?
      - Can a common area phone be made a member of a call queue?
      instructions:
      - text: Add {members} as members of call queue {callQueueId}.
        slots:
          members: requestBody.members
          callQueueId: path.callQueueId
      - text: Add common area {members} to call queue {callQueueId} as a member.
        slots:
          members: requestBody.members
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove every member from a call queue
      effect: destructive
      questions:
      - Is there a way to clear out all members of a call queue at once?
      - Can I empty a queue of every user and common area in one call?
      instructions:
      - text: Unassign all members from call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Clear every user and common area out of queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/members/{memberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one member from a call queue
      effect: destructive
      questions:
      - How do I take a single user out of a call queue?
      - Can I remove a queue manager with the single-member unassign?
      instructions:
      - text: Remove member {memberId} from call queue {callQueueId}.
        slots:
          memberId: path.memberId
          callQueueId: path.callQueueId
      - text: Take user {memberId} out of queue {callQueueId}.
        slots:
          memberId: path.memberId
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/phone_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign phone numbers to a call queue
      effect: write
      questions:
      - Can callers dial a direct number that rings a call queue?
      - What do I do after buying numbers to point them at a queue?
      instructions:
      - text: Assign phone numbers {phone_numbers} to call queue {callQueueId}.
        slots:
          phone_numbers: requestBody.phone_numbers
          callQueueId: path.callQueueId
      - text: Give call queue {callQueueId} the direct number {phone_numbers} so callers can dial it.
        slots:
          phone_numbers: requestBody.phone_numbers
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/phone_numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign all phone numbers from a call queue
      effect: destructive
      questions:
      - How do I unbind every direct number from a call queue at once?
      - Where do numbers go after I strip them all off a queue?
      instructions:
      - text: Unassign all phone numbers from call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Unbind every direct number from queue {callQueueId} and return them to unassigned.
        slots:
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/phone_numbers/{phoneNumberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign one phone number from a call queue
      effect: destructive
      questions:
      - Can I unbind just one of the numbers assigned to a call queue?
      - How do I move a single queue number back to the unassigned list?
      instructions:
      - text: Unassign phone number {phoneNumberId} from call queue {callQueueId}.
        slots:
          phoneNumberId: path.phoneNumberId
          callQueueId: path.callQueueId
      - text: Unbind just number {phoneNumberId} from queue {callQueueId}, leaving its other numbers.
        slots:
          phoneNumberId: path.phoneNumberId
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a call queue's policy settings
      effect: read
      questions:
      - Is voicemail transcription or auto call recording turned on for a queue?
      - What policy settings, like SMS or call screening, apply to one call queue?
      instructions:
      - text: Check whether voicemail transcription and auto recording are on for queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Get the policy (SMS, call screening, recording) for call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/policies'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a call queue's policy settings
      effect: write
      questions:
      - How do I turn on voicemail transcription for a call queue?
      - Can I block callers without caller ID on one queue?
      - Is it possible to enable automatic call recording at the queue level?
      instructions:
      - text: Turn on voicemail transcription for call queue {callQueueId} with {voicemail_transcription}.
        slots:
          callQueueId: path.callQueueId
          voicemail_transcription: requestBody.voicemail_transcription
      - text: Set auto call recording on call queue {callQueueId} to {auto_call_recording}.
        slots:
          callQueueId: path.callQueueId
          auto_call_recording: requestBody.auto_call_recording
      - text: Update call screening for call queue {callQueueId} to {call_screening}.
        slots:
          callQueueId: path.callQueueId
          call_screening: requestBody.call_screening
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/policies/{policyType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add shared voicemail access to a call queue
      effect: write
      questions:
      - How do I give extra people shared access to a call queue's voicemail?
      - Can I add voicemail access members under a queue policy type?
      instructions:
      - text: Add voicemail access members {voicemail_access_members} to call queue {callQueueId} under policy {policyType}.
        slots:
          voicemail_access_members: requestBody.voicemail_access_members
          callQueueId: path.callQueueId
          policyType: path.policyType
      - text: Grant new shared access to queue {callQueueId} voicemail via policy {policyType}.
        slots:
          callQueueId: path.callQueueId
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/policies/{policyType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove shared access members from a queue policy
      effect: destructive
      questions:
      - Can I revoke someone's shared voicemail access on a call queue?
      - Which IDs do I pass to remove shared access members from a queue policy?
      instructions:
      - text: Remove shared access {shared_ids} from call queue {callQueueId} policy {policyType}.
        slots:
          shared_ids: query.shared_ids
          callQueueId: path.callQueueId
          policyType: path.policyType
      - text: Revoke shared voicemail access {shared_ids} on queue {callQueueId} for policy {policyType}.
        slots:
          shared_ids: query.shared_ids
          callQueueId: path.callQueueId
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/policies/{policyType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change shared voicemail access on a call queue
      effect: write
      questions:
      - How do I change the permissions of people who already share a queue's voicemail?
      - Can I edit existing voicemail access members on a call queue policy?
      instructions:
      - text: Update voicemail access members on call queue {callQueueId} policy {policyType} to {voicemail_access_members}.
        slots:
          callQueueId: path.callQueueId
          policyType: path.policyType
          voicemail_access_members: requestBody.voicemail_access_members
      - text: Change permissions of existing shared voicemail members on queue {callQueueId} policy {policyType}.
        slots:
          callQueueId: path.callQueueId
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/recordings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a call queue's call recordings
      effect: read
      questions:
      - Where can I find recordings of calls handled by a call queue?
      - Can I fetch queue recordings for a specific date range?
      instructions:
      - text: List call recordings for call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: List call queue {callQueueId} recordings from {from} to {to}.
        slots:
          callQueueId: path.callQueueId
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a call queue's settings
      effect: read
      questions:
      - What settings are configured on a call queue, by setting type?
      - Can I read just one type of setting for a queue?
      instructions:
      - text: Get all typed settings configured on call queue {callQueueId}.
        slots:
          callQueueId: path.callQueueId
      - text: Show call queue {callQueueId}'s {setting_type} settings.
        slots:
          callQueueId: path.callQueueId
          setting_type: query.setting_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/settings/{settingType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a setting to a call queue by type
      effect: write
      questions:
      - Can I add a new setting entry of a given type to a call queue?
      - How is a setting type, like a holiday entry, added to a queue?
      instructions:
      - text: Add a {settingType} setting to call queue {callQueueId}.
        slots:
          settingType: path.settingType
          callQueueId: path.callQueueId
      - text: Create a new {settingType} entry on queue {callQueueId}.
        slots:
          settingType: path.settingType
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/settings/{settingType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a call queue setting by type
      effect: destructive
      questions:
      - How do I remove a holiday or break hour setting from a call queue?
      - Can I delete one setting type from a queue's configuration?
      instructions:
      - text: Delete the {settingType} setting from call queue {callQueueId}.
        slots:
          settingType: path.settingType
          callQueueId: path.callQueueId
      - text: Delete holiday {holiday_hour_id} from call queue {callQueueId}'s {settingType} setting.
        slots:
          holiday_hour_id: query.holiday_hour_id
          callQueueId: path.callQueueId
          settingType: path.settingType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/call_queues/{callQueueId}/settings/{settingType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a call queue setting by type
      effect: write
      questions:
      - Can I modify an existing setting of a particular type on a call queue?
      - How do I edit a queue setting that was added earlier?
      instructions:
      - text: Update the {settingType} setting on call queue {callQueueId}.
        slots:
          settingType: path.settingType
          callQueueId: path.callQueueId
      - text: Modify the existing {settingType} entry on queue {callQueueId}.
        slots:
          settingType: path.settingType
          callQueueId: path.callQueueId
      method: generated
      generated: '2026-10-01'