Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Outbound Calling API

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

$.info
$.paths['/phone/common_areas/{commonAreaId}/outbound_calling/countries_regions'].get
$.paths['/phone/common_areas/{commonAreaId}/outbound_calling/countries_regions'].patch
$.paths['/phone/common_areas/{commonAreaId}/outbound_calling/exception_rules'].get
$.paths['/phone/common_areas/{commonAreaId}/outbound_calling/exception_rules'].post
$.paths['/phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId}'].delete
$.paths['/phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId}'].patch
$.paths['/phone/outbound_calling/countries_regions'].get
$.paths['/phone/outbound_calling/countries_regions'].patch
$.paths['/phone/outbound_calling/exception_rules'].get
$.paths['/phone/outbound_calling/exception_rules'].post
$.paths['/phone/outbound_calling/exception_rules/{exceptionRuleId}'].delete
$.paths['/phone/outbound_calling/exception_rules/{exceptionRuleId}'].patch
$.paths['/phone/sites/{siteId}/outbound_calling/countries_regions'].get
$.paths['/phone/sites/{siteId}/outbound_calling/countries_regions'].patch
$.paths['/phone/sites/{siteId}/outbound_calling/exception_rules'].get

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 Outbound Calling API
  version: 1.0.0
extends: openapi/zoom-phone-outbound-calling-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: 24
- target: $.paths['/phone/common_areas/{commonAreaId}/outbound_calling/countries_regions'].get
  update:
    x-apievangelist-phrasing:
      intent: See which countries a common area phone can call
      effect: read
      questions:
      - Which countries and regions is the lobby common area phone allowed to dial out to?
      - Can I check the outbound calling country list for one specific common area?
      instructions:
      - text: Show the outbound calling countries and regions for common area {commonAreaId}.
        slots:
          commonAreaId: path.commonAreaId
      - text: List which countries common area {commonAreaId} can place outbound calls to, {page_size} per page.
        slots:
          commonAreaId: path.commonAreaId
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/common_areas/{commonAreaId}/outbound_calling/countries_regions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a common area's allowed calling countries
      effect: write
      questions:
      - How do I block international dialing to certain countries from a common area phone?
      - Can I allow a shared conference room phone to call a country it currently can't reach?
      instructions:
      - text: Update the allowed outbound calling countries for common area {commonAreaId} to {country_regions}.
        slots:
          commonAreaId: path.commonAreaId
          country_regions: requestBody.country_regions
      - text: Block outbound calls to a country from common area {commonAreaId}.
        slots:
          commonAreaId: path.commonAreaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/common_areas/{commonAreaId}/outbound_calling/exception_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a common area's outbound calling exceptions
      effect: read
      questions:
      - What outbound calling exception rules are set on a common area phone?
      - Can I filter a common area's calling exceptions by country or by whether they're active?
      instructions:
      - text: List the outbound calling exception rules for common area {commonAreaId}.
        slots:
          commonAreaId: path.commonAreaId
      - text: Show common area {commonAreaId} calling exceptions for country {country} with status {status}.
        slots:
          commonAreaId: path.commonAreaId
          country: query.country
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/common_areas/{commonAreaId}/outbound_calling/exception_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an outbound calling exception to a common area
      effect: write
      questions:
      - How do I let a common area phone dial one specific number prefix in an otherwise blocked country?
      - Can a common area have its own exception to the country calling policy?
      instructions:
      - text: Add outbound calling exception rule {exception_rule} to common area {commonAreaId}.
        slots:
          commonAreaId: path.commonAreaId
          exception_rule: requestBody.exception_rule
      - text: Create a calling exception for common area {commonAreaId} so it can reach a blocked number pattern.
        slots:
          commonAreaId: path.commonAreaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a common area's outbound calling exception
      effect: destructive
      questions:
      - How do I remove a calling exception rule from a common area phone?
      - What happens to a common area's dialing when I delete one of its exception rules?
      instructions:
      - text: Delete exception rule {exceptionRuleId} from common area {commonAreaId}.
        slots:
          commonAreaId: path.commonAreaId
          exceptionRuleId: path.exceptionRuleId
      - text: Remove the outbound calling exception {exceptionRuleId} on common area {commonAreaId}.
        slots:
          commonAreaId: path.commonAreaId
          exceptionRuleId: path.exceptionRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a common area's outbound calling exception
      effect: write
      questions:
      - Can I change the number pattern on an existing common area calling exception?
      - How would I deactivate a common area exception rule without deleting it?
      instructions:
      - text: Update exception rule {exceptionRuleId} on common area {commonAreaId} to {exception_rule}.
        slots:
          commonAreaId: path.commonAreaId
          exceptionRuleId: path.exceptionRuleId
          exception_rule: requestBody.exception_rule
      - text: Edit the common area {commonAreaId} calling exception {exceptionRuleId}.
        slots:
          commonAreaId: path.commonAreaId
          exceptionRuleId: path.exceptionRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_calling/countries_regions'].get
  update:
    x-apievangelist-phrasing:
      intent: See account-wide allowed calling countries
      effect: read
      questions:
      - Which countries can our whole Zoom Phone account place outbound calls to?
      - What does the account-level international dialing policy look like right now?
      instructions:
      - text: Show the account-level outbound calling countries and regions.
      - text: List the account's allowed outbound calling countries, {page_size} at a time.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_calling/countries_regions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change account-wide allowed calling countries
      effect: write
      questions:
      - How do I block outbound calls to a country for everyone on the account?
      - Can I open up international calling to a new region at the account level?
      instructions:
      - text: Set the account-wide outbound calling countries to {country_regions}.
        slots:
          country_regions: requestBody.country_regions
      - text: Block a country for outbound calls across the entire account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_calling/exception_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level outbound calling exceptions
      effect: read
      questions:
      - What exceptions to the country calling policy exist at the account level?
      - Can I search account calling exception rules by keyword or match type?
      instructions:
      - text: List all account-level outbound calling exception rules.
      - text: Find account calling exceptions matching {keyword} for country {country}.
        slots:
          keyword: query.keyword
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_calling/exception_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an account-level outbound calling exception
      effect: write
      questions:
      - How can I allow one number prefix account-wide even though its country is blocked?
      - Is there a way to add an exception to the account's outbound calling policy?
      instructions:
      - text: Add account-level outbound calling exception {exception_rule}.
        slots:
          exception_rule: requestBody.exception_rule
      - text: Create an exception rule in the account outbound calling policy for a blocked country.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_calling/exception_rules/{exceptionRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level calling exception
      effect: destructive
      questions:
      - How do I remove an exception from the account-wide outbound calling policy?
      - Can I delete an account calling exception rule I no longer need?
      instructions:
      - text: Delete account-level exception rule {exceptionRuleId}.
        slots:
          exceptionRuleId: path.exceptionRuleId
      - text: Remove the account outbound calling exception {exceptionRuleId}.
        slots:
          exceptionRuleId: path.exceptionRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/outbound_calling/exception_rules/{exceptionRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an account-level calling exception
      effect: write
      questions:
      - Can I modify an existing account-wide outbound calling exception rule?
      - How do I switch off an account-level calling exception temporarily?
      instructions:
      - text: Update account-level exception rule {exceptionRuleId} with {exception_rule}.
        slots:
          exceptionRuleId: path.exceptionRuleId
          exception_rule: requestBody.exception_rule
      - text: Change the pattern on account calling exception {exceptionRuleId}.
        slots:
          exceptionRuleId: path.exceptionRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_calling/countries_regions'].get
  update:
    x-apievangelist-phrasing:
      intent: See a site's allowed calling countries
      effect: read
      questions:
      - Which countries can phones at our London site dial?
      - What is the outbound calling country policy for one Zoom Phone site?
      instructions:
      - text: Show the outbound calling countries and regions for site {siteId}.
        slots:
          siteId: path.siteId
      - text: List site {siteId}'s allowed dialing countries.
        slots:
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_calling/countries_regions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a site's allowed calling countries
      effect: write
      questions:
      - How do I restrict international calling for just one office site?
      - Can I unblock a country for a single site without changing the account policy?
      instructions:
      - text: Update site {siteId}'s outbound calling countries to {country_regions}.
        slots:
          siteId: path.siteId
          country_regions: requestBody.country_regions
      - text: Block outbound calls to a country for everyone at site {siteId}.
        slots:
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_calling/exception_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's outbound calling exceptions
      effect: read
      questions:
      - What calling exception rules are configured for a particular site?
      - Can I see only the active outbound calling exceptions for one site?
      instructions:
      - text: List outbound calling exception rules for site {siteId}.
        slots:
          siteId: path.siteId
      - text: Show site {siteId} calling exceptions with status {status}.
        slots:
          siteId: path.siteId
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_calling/exception_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an outbound calling exception to a site
      effect: write
      questions:
      - How do I give one site an exception to dial a number in a blocked country?
      - Can a site have a calling exception that other sites don't get?
      instructions:
      - text: Add outbound calling exception {exception_rule} to site {siteId}.
        slots:
          siteId: path.siteId
          exception_rule: requestBody.exception_rule
      - text: Create a site-level calling exception for site {siteId}.
        slots:
          siteId: path.siteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_calling/exception_rules/{exceptionRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a site's outbound calling exception
      effect: destructive
      questions:
      - How do I take away a site's exception to the outbound calling policy?
      - Can I delete one calling exception rule from a site?
      instructions:
      - text: Delete exception rule {exceptionRuleId} from site {siteId}.
        slots:
          siteId: path.siteId
          exceptionRuleId: path.exceptionRuleId
      - text: Remove site {siteId}'s outbound calling exception {exceptionRuleId}.
        slots:
          siteId: path.siteId
          exceptionRuleId: path.exceptionRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sites/{siteId}/outbound_calling/exception_rules/{exceptionRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a site's outbound calling exception
      effect: write
      questions:
      - Can I change the number pattern on a site's existing calling exception?
      - How do I disable a site-level exception rule without removing it?
      instructions:
      - text: Update exception rule {exceptionRuleId} at site {siteId} with {exception_rule}.
        slots:
          siteId: path.siteId
          exceptionRuleId: path.exceptionRuleId
          exception_rule: requestBody.exception_rule
      - text: Edit site {siteId}'s calling exception {exceptionRuleId}.
        slots:
          siteId: path.siteId
          exceptionRuleId: path.exceptionRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/outbound_calling/countries_regions'].get
  update:
    x-apievangelist-phrasing:
      intent: See which countries a user can call
      effect: read
      questions:
      - Which countries is a specific employee allowed to call from Zoom Phone?
      - Why can't this user dial abroad - what's their personal country calling list?
      instructions:
      - text: Show the outbound calling countries and regions for user {userId}.
        slots:
          userId: path.userId
      - text: List the countries user {userId} can place outbound calls to.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/outbound_calling/countries_regions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a user's allowed calling countries
      effect: write
      questions:
      - How do I let one employee call a country that's blocked for everyone else?
      - Can I restrict a single user's international calling?
      instructions:
      - text: Update user {userId}'s outbound calling countries to {country_regions}.
        slots:
          userId: path.userId
          country_regions: requestBody.country_regions
      - text: Block a country for outbound calls from user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/outbound_calling/exception_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's outbound calling exceptions
      effect: read
      questions:
      - What personal calling exception rules does a user have?
      - Can I look up a user's outbound calling exceptions by keyword?
      instructions:
      - text: List outbound calling exception rules for user {userId}.
        slots:
          userId: path.userId
      - text: Find user {userId}'s calling exceptions matching {keyword}.
        slots:
          userId: path.userId
          keyword: query.keyword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/outbound_calling/exception_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an outbound calling exception for a user
      effect: write
      questions:
      - How do I let one user dial a specific blocked number pattern?
      - Can I give an individual user their own exception to the calling policy?
      instructions:
      - text: Add outbound calling exception {exception_rule} for user {userId}.
        slots:
          userId: path.userId
          exception_rule: requestBody.exception_rule
      - text: Create a user-level calling exception for user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/outbound_calling/exception_rules/{exceptionRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's outbound calling exception
      effect: destructive
      questions:
      - How do I revoke a user's exception to the outbound calling policy?
      - Can I delete a single user's calling exception rule?
      instructions:
      - text: Delete exception rule {exceptionRuleId} for user {userId}.
        slots:
          userId: path.userId
          exceptionRuleId: path.exceptionRuleId
      - text: Remove user {userId}'s outbound calling exception {exceptionRuleId}.
        slots:
          userId: path.userId
          exceptionRuleId: path.exceptionRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/outbound_calling/exception_rules/{exceptionRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a user's outbound calling exception
      effect: write
      questions:
      - Can I change the pattern on a user's existing calling exception?
      - How do I deactivate a user-level exception rule?
      instructions:
      - text: Update exception rule {exceptionRuleId} for user {userId} with {exception_rule}.
        slots:
          userId: path.userId
          exceptionRuleId: path.exceptionRuleId
          exception_rule: requestBody.exception_rule
      - text: Edit user {userId}'s calling exception {exceptionRuleId}.
        slots:
          userId: path.userId
          exceptionRuleId: path.exceptionRuleId
      method: generated
      generated: '2026-10-01'