Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Monitoring Groups API

10 actions 10 updates phrasing extends openapi/zoom-phone-monitoring-groups-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 10

$.info
$.paths['/phone/monitoring_groups'].get
$.paths['/phone/monitoring_groups'].post
$.paths['/phone/monitoring_groups/{monitoringGroupId}'].get
$.paths['/phone/monitoring_groups/{monitoringGroupId}'].delete
$.paths['/phone/monitoring_groups/{monitoringGroupId}'].patch
$.paths['/phone/monitoring_groups/{monitoringGroupId}/monitor_members'].get
$.paths['/phone/monitoring_groups/{monitoringGroupId}/monitor_members'].post
$.paths['/phone/monitoring_groups/{monitoringGroupId}/monitor_members'].delete
$.paths['/phone/monitoring_groups/{monitoringGroupId}/monitor_members/{memberExtensionId}'].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 Monitoring Groups API
  version: 1.0.0
extends: openapi/zoom-phone-monitoring-groups-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/monitoring_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitoring groups
      effect: read
      questions:
      - Which monitoring groups are set up for supervisors on our account?
      - Can I list monitoring groups for a single site or by type?
      instructions:
      - text: List all monitoring groups on the account.
      - text: List monitoring groups at site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/monitoring_groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitoring group
      effect: write
      questions:
      - How do I let supervisors listen in or barge into agents' calls?
      - Can I choose the monitoring privileges when creating a group?
      instructions:
      - text: Create a monitoring group named {name}.
        slots:
          name: requestBody.name
      - text: Create monitoring group {name} with privileges {monitoring_privileges}.
        slots:
          name: requestBody.name
          monitoring_privileges: requestBody.monitoring_privileges
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/monitoring_groups/{monitoringGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitoring group's details
      effect: read
      questions:
      - What privileges and prompt does a particular monitoring group have?
      - Where can I look up one monitoring group by its ID?
      instructions:
      - text: Show monitoring group {monitoringGroupId}.
        slots:
          monitoringGroupId: path.monitoringGroupId
      - text: Get the privileges configured on monitoring group {monitoringGroupId}.
        slots:
          monitoringGroupId: path.monitoringGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/monitoring_groups/{monitoringGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a monitoring group
      effect: destructive
      questions:
      - Can I delete a monitoring group altogether?
      - What removes a supervisor monitoring group from the account?
      instructions:
      - text: Delete monitoring group {monitoringGroupId}.
        slots:
          monitoringGroupId: path.monitoringGroupId
      - text: Remove the whole monitoring group {monitoringGroupId}.
        slots:
          monitoringGroupId: path.monitoringGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/monitoring_groups/{monitoringGroupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a monitoring group
      effect: write
      questions:
      - How do I change what supervisors in a monitoring group are allowed to do?
      - Can I rename a monitoring group or move it to another site?
      instructions:
      - text: Rename monitoring group {monitoringGroupId} to {name}.
        slots:
          monitoringGroupId: path.monitoringGroupId
          name: requestBody.name
      - text: Set the privileges of monitoring group {monitoringGroupId} to {monitoring_privileges}.
        slots:
          monitoringGroupId: path.monitoringGroupId
          monitoring_privileges: requestBody.monitoring_privileges
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/monitoring_groups/{monitoringGroupId}/monitor_members'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitors or monitored members of a group
      effect: read
      questions:
      - Who are the supervisors in a monitoring group?
      - Can I list just the monitored agents of a group?
      instructions:
      - text: List the {member_type} members of monitoring group {monitoringGroupId}.
        slots:
          member_type: query.member_type
          monitoringGroupId: path.monitoringGroupId
      - text: Show who is {member_type} in monitoring group {monitoringGroupId}.
        slots:
          member_type: query.member_type
          monitoringGroupId: path.monitoringGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/monitoring_groups/{monitoringGroupId}/monitor_members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to a monitoring group
      effect: write
      questions:
      - How do I add supervisors to a monitoring group?
      - Can I add the agents to be monitored to an existing group?
      instructions:
      - text: Add {member_type} members to monitoring group {monitoringGroupId}.
        slots:
          member_type: query.member_type
          monitoringGroupId: path.monitoringGroupId
      - text: Put new {member_type} users into monitoring group {monitoringGroupId}.
        slots:
          member_type: query.member_type
          monitoringGroupId: path.monitoringGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/monitoring_groups/{monitoringGroupId}/monitor_members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all monitors or monitored members
      effect: destructive
      questions:
      - Can I clear every supervisor out of a monitoring group in one go?
      - What removes all monitored members from a group at once?
      instructions:
      - text: Remove all {member_type} members from monitoring group {monitoringGroupId}.
        slots:
          member_type: query.member_type
          monitoringGroupId: path.monitoringGroupId
      - text: Clear every {member_type} out of monitoring group {monitoringGroupId}.
        slots:
          member_type: query.member_type
          monitoringGroupId: path.monitoringGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/monitoring_groups/{monitoringGroupId}/monitor_members/{memberExtensionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one member from a monitoring group
      effect: destructive
      questions:
      - How do I take one supervisor out of a monitoring group?
      - Can I remove a single monitored extension and keep the rest?
      instructions:
      - text: Remove extension {memberExtensionId} from monitoring group {monitoringGroupId}.
        slots:
          memberExtensionId: path.memberExtensionId
          monitoringGroupId: path.monitoringGroupId
      - text: Take only extension {memberExtensionId} out of group {monitoringGroupId}.
        slots:
          memberExtensionId: path.memberExtensionId
          monitoringGroupId: path.monitoringGroupId
      method: generated
      generated: '2026-10-01'