Zoom Phone · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Phone Dashboard API
12 actions
12 updates
phrasing
extends
openapi/zoom-phone-dashboard-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 12
$.info
$.paths['/phone/metrics/call_logs'].get
$.paths['/phone/metrics/call_logs/{callId}/qos'].get
$.paths['/phone/metrics/call_logs/{call_id}'].get
$.paths['/phone/metrics/emergency_services/default_emergency_address/users'].get
$.paths['/phone/metrics/emergency_services/detectable_personal_location/users'].get
$.paths['/phone/metrics/emergency_services/location_sharing_permission/users'].get
$.paths['/phone/metrics/emergency_services/nomadic_emergency_services/users'].get
$.paths['/phone/metrics/emergency_services/realtime_location/devices'].get
$.paths['/phone/metrics/emergency_services/realtime_location/users'].get
$.paths['/phone/metrics/location_tracking'].get
$.paths['/phone/metrics/past_calls'].get
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 Dashboard API
version: 1.0.0
extends: openapi/zoom-phone-dashboard-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: 11
- target: $.paths['/phone/metrics/call_logs'].get
update:
x-apievangelist-phrasing:
intent: List monthly call log metrics
effect: read
questions:
- Which calls last month had poor voice quality according to the dashboard?
- Can I filter dashboard call metrics by site and MOS quality score?
instructions:
- text: List dashboard call log metrics from {from} to {to}.
slots:
from: query.from
to: query.to
- text: Show {quality_type} quality calls for site {site_id} on the dashboard.
slots:
quality_type: query.quality_type
site_id: query.site_id
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/call_logs/{callId}/qos'].get
update:
x-apievangelist-phrasing:
intent: Get quality of service data for a call
effect: read
questions:
- Can I see jitter, packet loss and latency for a specific phone call?
- What QoS data is available to troubleshoot a choppy call?
instructions:
- text: Get the QoS data for call {callId}.
slots:
callId: path.callId
- text: Show network quality stats for call {callId}.
slots:
callId: path.callId
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/call_logs/{call_id}'].get
update:
x-apievangelist-phrasing:
intent: Get dashboard details for one call
effect: read
questions:
- Where can I get the dashboard's call details for a single call ID?
- Can I look up one call's metrics record from the call log dashboard?
instructions:
- text: Get dashboard call details for call {call_id}.
slots:
call_id: path.call_id
- text: Show the metrics record of call {call_id}.
slots:
call_id: path.call_id
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/emergency_services/default_emergency_address/users'].get
update:
x-apievangelist-phrasing:
intent: List users with a personal default emergency address
effect: read
questions:
- Which users rely on their own default emergency address instead of the site address?
- Can I filter users with personal default emergency addresses by site?
instructions:
- text: List users with a personal default emergency address in status {status}.
slots:
status: query.status
- text: Show personal default emergency address users at site {site_id} with status {status}.
slots:
site_id: query.site_id
status: query.status
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/emergency_services/detectable_personal_location/users'].get
update:
x-apievangelist-phrasing:
intent: List users with detectable personal locations
effect: read
questions:
- Which users have created personal locations tied to network data for emergency calling?
- Can I search users with detectable personal locations by keyword?
instructions:
- text: List users with detectable personal locations in status {status}.
slots:
status: query.status
- text: Find detectable personal location users matching {keyword} with status {status}.
slots:
keyword: query.keyword
status: query.status
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/emergency_services/location_sharing_permission/users'].get
update:
x-apievangelist-phrasing:
intent: List users who allow location sharing
effect: read
questions:
- Which users have allowed their devices to share location with the Zoom app?
- Can I check location sharing permission for users at one site?
instructions:
- text: List users who permit location sharing.
- text: Show location sharing permission for users at site {site_id}.
slots:
site_id: query.site_id
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/emergency_services/nomadic_emergency_services/users'].get
update:
x-apievangelist-phrasing:
intent: List users enabled for nomadic emergency services
effect: read
questions:
- Which users are enabled for nomadic emergency services?
- Can I filter nomadic emergency services users by status and site?
instructions:
- text: List nomadic emergency services users with status {status}.
slots:
status: query.status
- text: Show nomadic emergency services users at site {site_id} in status {status}.
slots:
site_id: query.site_id
status: query.status
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/emergency_services/realtime_location/devices'].get
update:
x-apievangelist-phrasing:
intent: List current locations of IP desk phones
effect: read
questions:
- Where are our IP desk phones currently detected?
- Can I search the real-time location of a desk phone by name or MAC address?
instructions:
- text: List real-time locations of IP phones for location type {location_type}.
slots:
location_type: query.location_type
- text: Find IP phone {keyword}'s current {location_type} location.
slots:
keyword: query.keyword
location_type: query.location_type
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/emergency_services/realtime_location/users'].get
update:
x-apievangelist-phrasing:
intent: List users' current detected locations
effect: read
questions:
- What is the currently detected location of each phone user right now?
- Can I see real-time user locations for a single site?
instructions:
- text: List users' real-time {location_type} locations.
slots:
location_type: query.location_type
- text: Show where users at site {site_id} are currently located, type {location_type}.
slots:
site_id: query.site_id
location_type: query.location_type
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/location_tracking'].get
update:
x-apievangelist-phrasing:
intent: List tracked locations
effect: read
questions:
- Which tracked locations does the emergency services dashboard record?
- Can I filter tracked locations by response type or device MAC address?
instructions:
- text: List all tracked locations.
- text: Show tracked locations of type {type} at site {site_id}.
slots:
type: query.type
site_id: query.site_id
method: generated
generated: '2026-10-01'
- target: $.paths['/phone/metrics/past_calls'].get
update:
x-apievangelist-phrasing:
intent: List past call metrics
effect: read
questions:
- Can I see quality metrics for past calls on one extension or phone number?
- Which past calls lasted over ten minutes, by department?
instructions:
- text: List past call metrics for number {phone_number} from {from} to {to}.
slots:
phone_number: query.phone_number
from: query.from
to: query.to
- text: Show past call metrics for extension {extension_number} with duration bucket {durations}.
slots:
extension_number: query.extension_number
durations: query.durations
method: generated
generated: '2026-10-01'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/zoom-phone-dashboard-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.