Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Alerts API

6 actions 6 updates phrasing extends openapi/zoom-phone-alerts-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 6

$.info

$.paths['/phone/alert_settings'].get

$.paths['/phone/alert_settings'].post

$.paths['/phone/alert_settings/{alertSettingId}'].get

$.paths['/phone/alert_settings/{alertSettingId}'].delete

$.paths['/phone/alert_settings/{alertSettingId}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Alerts API
  version: 1.0.0
extends: openapi/zoom-phone-alerts-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: 5
- target: $.paths['/phone/alert_settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone alert settings
      effect: read
      questions:
      - Which alerts are configured to warn us about call quality or queue problems?
      - Can I filter alert settings by module, rule or status?
      instructions:
      - text: List all phone alert settings.
      - text: Show alert settings for module {module} with status {status}.
        slots:
          module: query.module
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/alert_settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a phone alert setting
      effect: write
      questions:
      - Can I get emailed when a call queue crosses a threshold during business hours?
      - Is it possible to send phone system alerts to a chat channel?
      instructions:
      - text: 'Create alert {alert_setting_name}: {module}/{rule} on {target_type} if {rule_conditions}, {time_frame_type} {time_frame_from}-{time_frame_to}.'
        slots:
          alert_setting_name: requestBody.alert_setting_name
          module: requestBody.module
          rule: requestBody.rule
          target_type: requestBody.target_type
          rule_conditions: requestBody.rule_conditions
          time_frame_type: requestBody.time_frame_type
          time_frame_from: requestBody.time_frame_from
          time_frame_to: requestBody.time_frame_to
      - text: Add an alert setting that emails {email_recipients}.
        slots:
          email_recipients: requestBody.email_recipients
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/alert_settings/{alertSettingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert setting's details
      effect: read
      questions:
      - What conditions and recipients does a specific alert setting use?
      - Can I look up one alert rule by its ID?
      instructions:
      - text: Get alert setting {alertSettingId}.
        slots:
          alertSettingId: path.alertSettingId
      - text: Show who gets notified by alert {alertSettingId}.
        slots:
          alertSettingId: path.alertSettingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/alert_settings/{alertSettingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert setting
      effect: destructive
      questions:
      - Can I delete an alert rule that keeps firing for nothing?
      - Is removing an alert setting permanent?
      instructions:
      - text: Delete alert setting {alertSettingId}.
        slots:
          alertSettingId: path.alertSettingId
      - text: Remove the noisy alert {alertSettingId}.
        slots:
          alertSettingId: path.alertSettingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/alert_settings/{alertSettingId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an alert setting
      effect: write
      questions:
      - Can I change the recipients or frequency of an existing alert?
      - Is it possible to pause an alert setting by changing its status?
      instructions:
      - text: Set the status of alert {alertSettingId} to {status}.
        slots:
          alertSettingId: path.alertSettingId
          status: requestBody.status
      - text: Change alert {alertSettingId} to notify {email_recipients} at frequency {frequency}.
        slots:
          alertSettingId: path.alertSettingId
          email_recipients: requestBody.email_recipients
          frequency: requestBody.frequency
      method: generated
      generated: '2026-10-01'