Zoom Public API Documentation
Get common area phone details
GET {{baseUrl}}/phone/common_area_phones/:commonAreaPhoneId
Use this API to get details on a specific common area phone in an account. A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it. Prerequisites: Scopes:
phone:read:admin
Rate Limit Label: Light
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"calling_plans": [
{
"name": "US/CA Metered Calling Plan",
"type": 100
},
{
"name": "US/CA Metered Calling Plan",
"type": 100
}
],
"cost_center": "pbx cost center",
"department": "pbx department",
"device_type": "Polycom trio8500",
"emergency_address": {
"address_line1": "55 Almaden Blvd",
"address_line2": "8 floor",
"city": "San Jose",
"country": "US",
"id": "gBGwqgwoTb-DiSCA75tMWw",
"state_code": "CA",
"status": 3,
"zip": "95113"
},
"id": "5NmyHmVoRWWk4YT5ad6oxg",
"mac_address": "0004f25eec4d",
"name": "Test_cap",
"phone_numbers": [
{
"display_name": "phone number display name",
"id": "S5q4FDC3QsOCnO7LqHgqNw",
"number": "+12058945543",
"source": "internal"
},
{
"display_name": "phone number display name",
"id": "S5q4FDC3QsOCnO7LqHgqNw",
"number": "+12058945543",
"source": "internal"
}
],
"policy": {
"hot_desking": {
"status": "on"
},
"international_calling": {
"enable": true
},
"select_outbound_caller_id": {
"enable": true
}
},
"provision": {
"sip_accounts": [
{
"authorization_id": "352882557629",
"outbound_proxy": "dev01zpgatesj01.zoomdev.us:5091",
"password": "bnQBw0ow",
"secondary_outbound_proxy": "dev01zpgatesj02.zoomdev.us:5090",
"sip_domain": "10010236712.zoomdev.us",
"user_name": "username1001"
},
{
"authorization_id": "352882557629",
"outbound_proxy": "dev01zpgatesj01.zoomdev.us:5091",
"password": "bnQBw0ow",
"secondary_outbound_proxy": "dev01zpgatesj02.zoomdev.us:5090",
"sip_domain": "10010236712.zoomdev.us",
"user_name": "username1001"
}
],
"type": "assisted",
"url": "https://example.com/api/v2/pbx/provisioning/Polycom/trio8500"
},
"provision_template": {
"id": "CLbU64xzTzCUXz58e2Lo",
"name": "TestProvisionTemplate",
"supported": true
},
"site": {
"id": "8f71O6rWT8KFUGQmJIFAdQ",
"name": "Main Site"
},
"status": "offline",
"common_area_optimized": true
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/common_area_phones/:commonAreaPhoneId' -H 'Accept: application/json'
ENDPOINTS