Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Routing Rules API

6 actions 6 updates phrasing extends openapi/zoom-phone-routing-rules-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/routing_rules'].get

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

$.paths['/phone/routing_rules/{routingRuleId}'].get

$.paths['/phone/routing_rules/{routingRuleId}'].delete

$.paths['/phone/routing_rules/{routingRuleId}'].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 Routing Rules API
  version: 1.0.0
extends: openapi/zoom-phone-routing-rules-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/routing_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List directory backup routing rules
      effect: read
      questions:
      - Which backup routing rules apply when a dialed number matches no user?
      - Can I list the routing rules for a single site?
      instructions:
      - text: List the directory backup routing rules.
      - text: List backup routing rules for site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/routing_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a directory backup routing rule
      effect: write
      questions:
      - How do I route unmatched dialed numbers to a SIP group with a regex?
      - Can a backup routing rule translate the dialed number?
      instructions:
      - text: Add a backup routing rule {name} matching {number_pattern}.
        slots:
          name: requestBody.name
          number_pattern: requestBody.number_pattern
      - text: Add rule {name} sending numbers matching {number_pattern} to SIP group {sip_group_id}.
        slots:
          name: requestBody.name
          number_pattern: requestBody.number_pattern
          sip_group_id: requestBody.sip_group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/routing_rules/{routingRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a directory backup routing rule
      effect: read
      questions:
      - What pattern and translation does one backup routing rule use?
      - Where can I inspect a single routing rule?
      instructions:
      - text: Show routing rule {routingRuleId}.
        slots:
          routingRuleId: path.routingRuleId
      - text: Get the number pattern of routing rule {routingRuleId}.
        slots:
          routingRuleId: path.routingRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/routing_rules/{routingRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a directory backup routing rule
      effect: destructive
      questions:
      - Can I remove a backup routing rule we no longer need?
      - What deletes one directory backup routing rule?
      instructions:
      - text: Delete routing rule {routingRuleId}.
        slots:
          routingRuleId: path.routingRuleId
      - text: Remove backup routing rule {routingRuleId}.
        slots:
          routingRuleId: path.routingRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/routing_rules/{routingRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a directory backup routing rule
      effect: write
      questions:
      - How do I change the regex pattern of a backup routing rule?
      - Can I reorder backup routing rules so one is tested first?
      instructions:
      - text: Set the pattern of routing rule {routingRuleId} to {number_pattern}.
        slots:
          routingRuleId: path.routingRuleId
          number_pattern: requestBody.number_pattern
      - text: Move routing rule {routingRuleId} to position {order}.
        slots:
          routingRuleId: path.routingRuleId
          order: requestBody.order
      method: generated
      generated: '2026-10-01'