Get common area details
GET {{baseUrl}}/phone/common_areas/:commonAreaId
Use this API to get detailed information on the common area.
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
:
LIGHT
HEADERS
| Key | Datatype | Required | Description |
| Accept
| string | | |
RESPONSES
status: OK
{"area_code":"\u003cstring\u003e","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"}],"cost_center":"\u003cstring\u003e","country":{"code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"department":"\u003cstring\u003e","display_name":"\u003cstring\u003e","extension_number":"\u003clong\u003e","emergency_address":{"address_line1":"\u003cstring\u003e","address_line2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","id":"\u003cstring\u003e","state_code":"\u003cstring\u003e","status":1,"zip":"\u003cstring\u003e"},"id":"\u003cstring\u003e","outbound_caller_ids":[{"is_default":"\u003cboolean\u003e","name":"\u003cstring\u003e","number":"\u003cstring\u003e"},{"is_default":"\u003cboolean\u003e","name":"\u003cstring\u003e","number":"\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"}],"policy":{"international_calling":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"outbound_calling":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","modified":"\u003cboolean\u003e"}},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"status":"offline"}