Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Call Handling API

5 actions 5 updates phrasing extends openapi/zoom-phone-call-handling-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 5

$.info
$.paths['/phone/extension/{extensionId}/call_handling/settings'].get
$.paths['/phone/extension/{extensionId}/call_handling/settings/{settingType}'].post
$.paths['/phone/extension/{extensionId}/call_handling/settings/{settingType}'].delete
$.paths['/phone/extension/{extensionId}/call_handling/settings/{settingType}'].patch

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 Handling API
  version: 1.0.0
extends: openapi/zoom-phone-call-handling-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: 4
- target: $.paths['/phone/extension/{extensionId}/call_handling/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an extension's call handling settings
      effect: read
      questions:
      - How does a call queue or user extension route calls during business, closed and holiday hours?
      - Can I see all call handling settings for one extension in a single response?
      instructions:
      - text: Show the call handling settings for extension {extensionId}.
        slots:
          extensionId: path.extensionId
      - text: Get business, closed and holiday routing of extension {extensionId}.
        slots:
          extensionId: path.extensionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/extension/{extensionId}/call_handling/settings/{settingType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a call handling subsetting to an extension
      effect: write
      questions:
      - Can I add a new holiday or forwarding rule to a call queue's call handling?
      - 'Which extensions support adding call handling subsettings: users, queues, auto receptionists?'
      instructions:
      - text: Add a {settingType} call handling subsetting to extension {extensionId}.
        slots:
          settingType: path.settingType
          extensionId: path.extensionId
      - text: Create a holiday hours entry in extension {extensionId}'s call handling.
        slots:
          extensionId: path.extensionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/extension/{extensionId}/call_handling/settings/{settingType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a call handling subsetting from an extension
      effect: destructive
      questions:
      - Can I remove a forwarding destination from an extension's call handling?
      - Is it possible to delete one holiday from a call queue's routing rules?
      instructions:
      - text: Delete forwarding {call_forwarding_id} from extension {extensionId}'s {settingType} handling.
        slots:
          call_forwarding_id: query.call_forwarding_id
          extensionId: path.extensionId
          settingType: path.settingType
      - text: Remove holiday {holiday_id} from extension {extensionId}'s {settingType} call handling.
        slots:
          holiday_id: query.holiday_id
          extensionId: path.extensionId
          settingType: path.settingType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/extension/{extensionId}/call_handling/settings/{settingType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an extension's call handling setting
      effect: write
      questions:
      - Can I change how a call queue routes callers during closed hours?
      - Is it possible to edit an extension's existing business hours routing?
      instructions:
      - text: Update the {settingType} call handling of extension {extensionId}.
        slots:
          settingType: path.settingType
          extensionId: path.extensionId
      - text: Change the closed hours routing for extension {extensionId}.
        slots:
          extensionId: path.extensionId
      method: generated
      generated: '2026-10-01'