Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Blocked List API

6 actions 6 updates phrasing extends openapi/zoom-phone-blocked-list-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/blocked_list'].get

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

$.paths['/phone/blocked_list/{blockedListId}'].get

$.paths['/phone/blocked_list/{blockedListId}'].delete

$.paths['/phone/blocked_list/{blockedListId}'].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 Blocked List API
  version: 1.0.0
extends: openapi/zoom-phone-blocked-list-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/blocked_list'].get
  update:
    x-apievangelist-phrasing:
      intent: List blocked numbers
      effect: read
      questions:
      - Which phone numbers are blocked on our account?
      - Can I see both inbound and outbound blocked numbers in one list?
      instructions:
      - text: List all blocked numbers on the account.
      - text: Show {page_size} blocked list entries per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/blocked_list'].post
  update:
    x-apievangelist-phrasing:
      intent: Block a phone number
      effect: write
      questions:
      - How do I stop a spam number from calling our users?
      - Can I block outbound dialing to a particular number or prefix?
      instructions:
      - text: Block phone number {phone_number}.
        slots:
          phone_number: requestBody.phone_number
      - text: Block {phone_number} for {block_type} calls with match type {match_type}.
        slots:
          phone_number: requestBody.phone_number
          block_type: requestBody.block_type
          match_type: requestBody.match_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/blocked_list/{blockedListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blocked number entry
      effect: read
      questions:
      - What are the details of one blocked number entry?
      - Is a specific blocked list entry inbound or outbound?
      instructions:
      - text: Show blocked list entry {blockedListId}.
        slots:
          blockedListId: path.blockedListId
      - text: Check the block type of entry {blockedListId}.
        slots:
          blockedListId: path.blockedListId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/blocked_list/{blockedListId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unblock a number by deleting its entry
      effect: destructive
      questions:
      - How do I unblock a number that was blocked by mistake?
      - Does deleting a blocked list entry unblock the number right away?
      instructions:
      - text: Delete blocked list entry {blockedListId}.
        slots:
          blockedListId: path.blockedListId
      - text: Unblock the number in entry {blockedListId}.
        slots:
          blockedListId: path.blockedListId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/blocked_list/{blockedListId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a blocked number entry
      effect: write
      questions:
      - Can I change a blocked entry from inbound to outbound?
      - How do I temporarily deactivate a block without deleting it?
      instructions:
      - text: Set the status of blocked entry {blockedListId} to {status}.
        slots:
          blockedListId: path.blockedListId
          status: requestBody.status
      - text: Change blocked entry {blockedListId} to block {block_type} calls.
        slots:
          blockedListId: path.blockedListId
          block_type: requestBody.block_type
      method: generated
      generated: '2026-10-01'