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
Request Params
| 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":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"}],"display_name":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","phone_numbers":[{"display_name":"\u003cstring\u003e","id":"\u003cstring\u003e","number":"\u003cstring\u003e","source":"external"},{"display_name":"\u003cstring\u003e","id":"\u003cstring\u003e","number":"\u003cstring\u003e","source":"internal"}],"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"status":"offline","desk_phones":[{"id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","device_type":"\u003cstring\u003e","status":"offline"},{"id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","device_type":"\u003cstring\u003e","status":"offline"}]},{"calling_plans":[{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"}],"display_name":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","phone_numbers":[{"display_name":"\u003cstring\u003e","id":"\u003cstring\u003e","number":"\u003cstring\u003e","source":"internal"},{"display_name":"\u003cstring\u003e","id":"\u003cstring\u003e","number":"\u003cstring\u003e","source":"external"}],"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"status":"online","desk_phones":[{"id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","device_type":"\u003cstring\u003e","status":"online"},{"id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","device_type":"\u003cstring\u003e","status":"online"}]}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e"}