Zoom Phone · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Phone Inbound Blocked List API
11 actions
11 updates
phrasing
extends
openapi/zoom-phone-inbound-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/phone/extension/{extensionId}/inbound_blocked/rules'].get
$.paths['/phone/extension/{extensionId}/inbound_blocked/rules'].post
$.paths['/phone/extension/{extensionId}/inbound_blocked/rules'].delete
$.paths['/phone/inbound_blocked/extension_rules/statistics'].get
$.paths['/phone/inbound_blocked/extension_rules/statistics'].delete
$.paths['/phone/inbound_blocked/extension_rules/statistics/blocked_for_all'].patch
$.paths['/phone/inbound_blocked/rules'].get
$.paths['/phone/inbound_blocked/rules'].post
$.paths['/phone/inbound_blocked/rules'].delete
$.paths['/phone/inbound_blocked/rules/{blockedRuleId}'].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 Inbound Blocked List API
version: 1.0.0
extends: openapi/zoom-phone-inbound-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: 10
- target: $.paths['/phone/extension/{extensionId}/inbound_blocked/rules'].get
update:
x-apievangelist-phrasing:
intent: List an extension's inbound block rules
effect: read
questions:
- Which numbers are blocked from calling or texting a particular call queue or user?
- Can I search one extension's block rules by number or match type?
instructions:
- text: List inbound block rules for extension {extensionId}.
slots:
extensionId: path.extensionId
- text: Find block rules on extension {extensionId} matching {keyword}.
slots:
extensionId: path.extensionId
keyword: query.keyword
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/extension/{extensionId}/inbound_blocked/rules'].post
update:
x-apievangelist-phrasing:
intent: Block an inbound number for one extension
effect: write
questions:
- Can I block a spam number from reaching just one user or call queue?
- Is it possible to block calls and messages by country prefix for a single extension?
instructions:
- text: Block {blocked_number} for extension {extensionId} using {match_type} match and type {type}.
slots:
blocked_number: requestBody.blocked_number
extensionId: path.extensionId
match_type: requestBody.match_type
type: requestBody.type
- text: Add a {match_type} block rule of type {type} on extension {extensionId} for country {country}.
slots:
match_type: requestBody.match_type
type: requestBody.type
extensionId: path.extensionId
country: requestBody.country
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/extension/{extensionId}/inbound_blocked/rules'].delete
update:
x-apievangelist-phrasing:
intent: Delete an extension's inbound block rule
effect: destructive
questions:
- Can I unblock a number that was blocked only for a single extension?
- Which ID do I need to remove a block rule from a user or call queue?
instructions:
- text: Delete block rule {blocked_rule_id} from extension {extensionId}.
slots:
blocked_rule_id: query.blocked_rule_id
extensionId: path.extensionId
- text: Unblock rule {blocked_rule_id} on extension {extensionId}.
slots:
blocked_rule_id: query.blocked_rule_id
extensionId: path.extensionId
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/inbound_blocked/extension_rules/statistics'].get
update:
x-apievangelist-phrasing:
intent: List statistics of extension-level blocked numbers
effect: read
questions:
- Which numbers are being blocked by many extensions across the account?
- Can I see blocked-number statistics rolled up across extensions?
instructions:
- text: List inbound blocked statistics across all extensions.
- text: Show blocked number statistics matching {keyword}.
slots:
keyword: query.keyword
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/inbound_blocked/extension_rules/statistics'].delete
update:
x-apievangelist-phrasing:
intent: Delete an inbound blocked statistic
effect: destructive
questions:
- Can I clear a blocked-number statistic entry from the extension rollup?
- Is it possible to delete one row from the inbound blocked statistics?
instructions:
- text: Delete blocked statistic {blocked_statistic_id}.
slots:
blocked_statistic_id: query.blocked_statistic_id
- text: Clear inbound blocked statistic entry {blocked_statistic_id}.
slots:
blocked_statistic_id: query.blocked_statistic_id
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/inbound_blocked/extension_rules/statistics/blocked_for_all'].patch
update:
x-apievangelist-phrasing:
intent: Promote a blocked number to block all extensions
effect: write
questions:
- Can I take a number one extension blocked and block it for everyone in the account?
- Is there a way to promote an extension-level block to an account-wide block?
instructions:
- text: Block the number in statistic {blocked_statistic_id} for all extensions.
slots:
blocked_statistic_id: requestBody.blocked_statistic_id
- text: Promote blocked statistic {blocked_statistic_id} to an account-level block.
slots:
blocked_statistic_id: requestBody.blocked_statistic_id
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/inbound_blocked/rules'].get
update:
x-apievangelist-phrasing:
intent: List account-wide inbound block rules
effect: read
questions:
- Which numbers are blocked company-wide from calling or texting us?
- Can I filter account-level block rules by active status?
instructions:
- text: List the account-level inbound block rules.
- text: Show account-wide block rules with status {status}.
slots:
status: query.status
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/inbound_blocked/rules'].post
update:
x-apievangelist-phrasing:
intent: Block an inbound number for the whole account
effect: write
questions:
- How do I block a robocaller from reaching every extension in the company?
- Can I add a comment explaining why a number was blocked account-wide?
instructions:
- text: Block {blocked_number} for the whole account with {match_type} match, type {type}, status {status}.
slots:
blocked_number: requestBody.blocked_number
match_type: requestBody.match_type
type: requestBody.type
status: requestBody.status
- text: Add an account block rule ({match_type}, {type}, {status}) noting {comment}.
slots:
match_type: requestBody.match_type
type: requestBody.type
status: requestBody.status
comment: requestBody.comment
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/inbound_blocked/rules'].delete
update:
x-apievangelist-phrasing:
intent: Delete an account-wide inbound block rule
effect: destructive
questions:
- Can I unblock a number that was blocked for the entire company?
- What's needed to delete an account-level block rule?
instructions:
- text: Delete account-level block rule {blocked_rule_id}.
slots:
blocked_rule_id: query.blocked_rule_id
- text: Remove the company-wide block {blocked_rule_id}.
slots:
blocked_rule_id: query.blocked_rule_id
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/inbound_blocked/rules/{blockedRuleId}'].patch
update:
x-apievangelist-phrasing:
intent: Update an account-wide inbound block rule
effect: write
questions:
- Can I deactivate an account-wide block rule without deleting it?
- Is it possible to change the blocked number or comment on an existing company block rule?
instructions:
- text: Update account block rule {blockedRuleId} to {match_type} match and type {type}.
slots:
blockedRuleId: path.blockedRuleId
match_type: requestBody.match_type
type: requestBody.type
- text: Set status {status} on account block rule {blockedRuleId} ({match_type}, {type}).
slots:
status: requestBody.status
blockedRuleId: path.blockedRuleId
match_type: requestBody.match_type
type: requestBody.type
method: generated
generated: '2026-10-01'