Logo
Zoom Public API Documentation

List common areas

GET {{baseUrl}}/phone/common_areas?page_size=30&next_page_token=<string>

Lists common areas under an account.

Note: For use by customers who opted for Common Area Optimization

Prerequisites:

  • Pro or a higher account with Zoom Phone license
  • Account owner or admin permissions

Scopes: phone:read:admin

Granular Scopes: phone:read:common_area:admin

Rate Limit Label: MEDIUM

 

Body PARAM

Key Datatype Required Description  
page_size
 number The total number of records returned from a single API call. 
next_page_token
 string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.



HEADERS

Key Datatype Required Description  
Accept
 string




RESPONSES

status OK

{ "common_areas": [ { "calling_plans": [ { "name": "<string>", "type": "<integer>", "billing_account_id": "<string>", "billing_account_name": "<string>" }, { "name": "<string>", "type": "<integer>", "billing_account_id": "<string>", "billing_account_name": "<string>" } ], "display_name": "<string>", "extension_number": "<long>", "id": "<string>", "phone_numbers": [ { "display_name": "<string>", "id": "<string>", "number": "<string>", "source": "external" }, { "display_name": "<string>", "id": "<string>", "number": "<string>", "source": "internal" } ], "site": { "id": "<string>", "name": "<string>" }, "status": "offline", "desk_phones": [ { "id": "<string>", "display_name": "<string>", "device_type": "<string>", "status": "offline" }, { "id": "<string>", "display_name": "<string>", "device_type": "<string>", "status": "offline" } ] }, { "calling_plans": [ { "name": "<string>", "type": "<integer>", "billing_account_id": "<string>", "billing_account_name": "<string>" }, { "name": "<string>", "type": "<integer>", "billing_account_id": "<string>", "billing_account_name": "<string>" } ], "display_name": "<string>", "extension_number": "<long>", "id": "<string>", "phone_numbers": [ { "display_name": "<string>", "id": "<string>", "number": "<string>", "source": "internal" }, { "display_name": "<string>", "id": "<string>", "number": "<string>", "source": "external" } ], "site": { "id": "<string>", "name": "<string>" }, "status": "online", "desk_phones": [ { "id": "<string>", "display_name": "<string>", "device_type": "<string>", "status": "online" }, { "id": "<string>", "display_name": "<string>", "device_type": "<string>", "status": "online" } ] } ], "next_page_token": "<string>", "page_size": "<integer>" }


Curl
curl -X GET 'https://api.zoom.us/v2/phone/common_areas?page_size=30&next_page_token=<string>?page_size=30&next_page_token=<string>' -H 'Accept: application/json'

  • Ask Qodex

  • Introduction

  • FAQs

  • More

    Github

    Developer Website

    Claim this page

    Report this page

ENDPOINTS