Zoom Phone

Zoom Phone Common Areas API

The Common Areas API from Zoom Phone — 14 operation(s) for common areas.

GitHub OpenAPI

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /phone/common_areas List common area phones · List common areas #
Ask an LLM
“Which common area phones are set up across our account?”
“Can I filter common areas by site or by device type?”
Tell an agent
List all common areas on the account.
List the common areas at site {site_id}.
POST /phone/common_areas Add a common area · Add a common area #
Ask an LLM
“How do I set up a shared lobby phone as a common area?”
“Can I apply a template and calling plan when adding a common area?”
Tell an agent
Add a common area named {display_name}.
Add common area {display_name} at site {site_id} with extension {extension_number}.
POST /phone/common_areas/activation_code Generate activation codes for common areas · Generate activation codes for common areas #
Ask an LLM
“How do I get activation codes so shared phones can sign in as common areas?”
“What is the most common areas I can generate activation codes for at once?”
Tell an agent
Generate activation codes for common areas {common_area_ids}.
Create fresh activation codes for the shared phones {common_area_ids}.
GET /phone/common_areas/activation_codes List common area activation codes · List activation codes #
Ask an LLM
“Where can I see the activation codes already issued to our common areas?”
“Is there a list of every common area activation code on the account?”
Tell an agent
List the activation codes for our common areas.
Show {page_size} common area activation codes per page.
POST /phone/common_areas/template_id/{templateId} Apply a setting template to common areas · Apply template to common areas #
Ask an LLM
“Can I push one setting template to many common areas in bulk?”
“How many common areas can a template be applied to in a single request?”
Tell an agent
Apply template {templateId} to common areas {common_area_ids}.
Roll setting template {templateId} out to the common area phones.
GET /phone/common_areas/{commonAreaId} Get a common area's details · Get common area details #
Ask an LLM
“What extension and numbers does a particular common area phone have?”
“Where do I look up one common area's configuration?”
Tell an agent
Show details for common area {commonAreaId}.
Look up the extension and site of common area {commonAreaId}.
DELETE /phone/common_areas/{commonAreaId} Delete a common area · Delete a common area #
Ask an LLM
“Can I remove a common area phone we no longer need?”
“What happens to a common area when it is deleted?”
Tell an agent destructive · confirm first
Delete common area {commonAreaId}.
Remove common area {commonAreaId} from the account.
PATCH /phone/common_areas/{commonAreaId} Update a common area's profile · Update common area #
Ask an LLM
“How do I change a common area's display name or extension?”
“Can I set a common area's outbound caller ID or emergency address?”
Tell an agent
Rename common area {commonAreaId} to {display_name}.
Set the outbound caller ID of common area {commonAreaId} to {outbound_caller_id}.
GET /phone/common_areas/{commonAreaId}/call_handling/settings Get a common area's call handling for an hour type · Get common area call handling setting #
Ask an LLM
“What happens to calls to a lobby phone after business hours?”
“Can I see a common area's call handling for a holiday?”
Tell an agent
Show the call handling setting of common area {commonAreaId}.
Show common area {commonAreaId}'s call handling during {hour_type} hours.
PATCH /phone/common_areas/{commonAreaId}/call_handling/settings/{hourType} Change a common area's call handling for an hour type · Update common area call handling setting #
Ask an LLM
“How do I forward a common area phone's calls during closed hours?”
“Can I change call distribution on a shared phone for business hours?”
Tell an agent
Update common area {commonAreaId}'s call handling for {hourType} hours.
Set common area {commonAreaId} {hourType}-hours call handling to {call_handling_setting}.
POST /phone/common_areas/{commonAreaId}/calling_plans Assign calling plans to a common area · Assign calling plans to a common area #
Ask an LLM
“How do I give a common area phone a calling plan so it can dial out?”
“Can more than one calling plan be assigned to a shared phone?”
Tell an agent
Assign calling plans {calling_plans} to common area {commonAreaId}.
Give common area {commonAreaId} the calling plan {calling_plans}.
DELETE /phone/common_areas/{commonAreaId}/calling_plans/{type} Remove a calling plan from a common area · Unassign a calling plan from the common area #
Ask an LLM
“Can I take a calling plan away from a common area phone?”
“Which billing account does unassigning a common area plan apply to?”
Tell an agent destructive · confirm first
Unassign calling plan type {type} from common area {commonAreaId}.
Remove plan {type} from common area {commonAreaId} under billing account {billing_account_id}.
POST /phone/common_areas/{commonAreaId}/phone_numbers Assign phone numbers to a common area · Assign phone numbers to a common area #
Ask an LLM
“How do I give a lobby phone its own direct phone number?”
“Can several numbers be assigned to one common area?”
Tell an agent
Assign phone numbers {phone_numbers} to common area {commonAreaId}.
Give common area {commonAreaId} the direct number {phone_numbers}.
DELETE /phone/common_areas/{commonAreaId}/phone_numbers/{phoneNumberId} Unassign a phone number from a common area · Unassign phone numbers from common area #
Ask an LLM
“Can I take a direct number back from a common area phone?”
“What frees up a number currently assigned to a shared phone?”
Tell an agent destructive · confirm first
Unassign phone number {phoneNumberId} from common area {commonAreaId}.
Free number {phoneNumberId} from shared phone {commonAreaId}.
PATCH /phone/common_areas/{commonAreaId}/pin_code Change a common area's PIN code · Update common area pin code #
Ask an LLM
“How do I reset the PIN on a common area phone?”
“Can an admin change a shared phone's PIN when PIN viewing is restricted?”
Tell an agent
Set the PIN code of common area {commonAreaId} to {pin_code}.
Reset common area {commonAreaId}'s PIN to {pin_code}.
GET /phone/common_areas/{commonAreaId}/settings Get a common area's settings · Get common area settings #
Ask an LLM
“What settings, like desk phone configuration, does a common area have?”
“Can I read only one setting type for a shared phone?”
Tell an agent
Show the settings of common area {commonAreaId}.
Show common area {commonAreaId}'s {setting_type} settings.
POST /phone/common_areas/{commonAreaId}/settings/{settingType} Add a setting to a common area by type · Add common area setting #
Ask an LLM
“Can I add a new setting entry of a given type to a common area?”
“How is a typed setting added to a shared phone for the first time?”
Tell an agent
Add a {settingType} setting to common area {commonAreaId}.
Create a new {settingType} entry on shared phone {commonAreaId}.
DELETE /phone/common_areas/{commonAreaId}/settings/{settingType} Remove a common area setting from desk phones · Delete common area setting #
Ask an LLM
“How do I remove a common area subsetting from a desk phone?”
“Can I delete a holiday entry from a common area's settings?”
Tell an agent destructive · confirm first
Delete the {settingType} setting from common area {commonAreaId}.
Remove common area {commonAreaId}'s {settingType} setting from device {device_id}.
PATCH /phone/common_areas/{commonAreaId}/settings/{settingType} Update a common area setting by type · Update common area setting #
Ask an LLM
“Can I edit an existing typed setting on a common area?”
“How do I modify a shared phone setting that is already in place?”
Tell an agent
Update the {settingType} setting on common area {commonAreaId}.
Modify the existing {settingType} entry for shared phone {commonAreaId}.

Documentation

📖
Documentation
https://developers.zoom.us/docs/api/phone/
📖
APIReference
https://developers.zoom.us/docs/api/phone/
📖
Documentation
https://developers.zoom.us/docs/integrations/oauth/
📖
Documentation
https://developers.zoom.us/docs/api/phone/events/
📖
APIReference
https://developers.zoom.us/docs/api/phone/events/
📖
Documentation
https://developers.zoom.us/docs/api/number-management/
📖
APIReference
https://developers.zoom.us/docs/api/number-management/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoom-phone/refs/heads/main/openapi/zoom-phone-common-areas-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://www.postman.com/zoom-developer/zoom-public-workspace/documentation/uba96fr/phone

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zoom-phone:zoom-phone-common-areas-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoom-phone-common-areas-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Phone Common Areas API
  description: 'You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the Zoom App Marketplace.


    To learn how to get your credentials and create private or public applications, see Zoom APIs use OAuth 2.0 authorization.


    All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You''ll receive a `403` error message if you have not set up Zoom Phone.'
  termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
  contact:
    name: Zoom Developers
    url: https://developer.zoom.us/
  version: '2'
servers:
- url: https://api.zoom.us/v2
tags:


# --- truncated at 32 KB (201 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoom-phone/refs/heads/main/openapi/zoom-phone-common-areas-api-openapi.yml