Zoom Public API Documentation
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 Prerequisites: Scopes: Granular Scopes: Rate Limit Label: Common Area Optimization
phone:read:adminphone:read:common_area:adminLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"area_code": "<string>",
"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>"
}
],
"cost_center": "<string>",
"country": {
"code": "<string>",
"country_code": "<string>",
"name": "<string>"
},
"department": "<string>",
"display_name": "<string>",
"extension_number": "<long>",
"emergency_address": {
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"country": "<string>",
"id": "<string>",
"state_code": "<string>",
"status": 1,
"zip": "<string>"
},
"id": "<string>",
"outbound_caller_ids": [
{
"is_default": "<boolean>",
"name": "<string>",
"number": "<string>"
},
{
"is_default": "<boolean>",
"name": "<string>",
"number": "<string>"
}
],
"phone_numbers": [
{
"display_name": "<string>",
"id": "<string>",
"number": "<string>",
"source": "internal"
},
{
"display_name": "<string>",
"id": "<string>",
"number": "<string>",
"source": "external"
}
],
"policy": {
"international_calling": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"outbound_calling": {
"enable": "<boolean>",
"locked": "<boolean>",
"modified": "<boolean>"
}
},
"site": {
"id": "<string>",
"name": "<string>"
},
"status": "offline"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/common_areas/:commonAreaId' -H 'Accept: application/json'
ENDPOINTS