Zoom Public API Documentation
Get device line keys information
GET {{baseUrl}}/phone/devices/:deviceId/line_keys
Use this API to get information on the Zoom Phone device line keys settings and position. Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:admin,phone:readphone:read:device_line_keys,phone:read:device_line_keys:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"device_id": "<string>",
"device_name": "<string>",
"positions": [
{
"index": "<integer>",
"owner_extension_name": "<string>",
"owner_extension_number": "<long>",
"extension_number": "<long>",
"extension_type": "User",
"extension_id": "<string>",
"display_name": "<string>",
"phone_number": "<string>",
"outbound_caller_ids": [
{
"extension_id": "<string>",
"phone_number": "<string>",
"usage_type": "Direct Number"
},
{
"extension_id": "<string>",
"phone_number": "<string>",
"usage_type": "Phone Number"
}
]
},
{
"index": "<integer>",
"owner_extension_name": "<string>",
"owner_extension_number": "<long>",
"extension_number": "<long>",
"extension_type": "CommonArea",
"extension_id": "<string>",
"display_name": "<string>",
"phone_number": "<string>",
"outbound_caller_ids": [
{
"extension_id": "<string>",
"phone_number": "<string>",
"usage_type": "Phone Number"
},
{
"extension_id": "<string>",
"phone_number": "<string>",
"usage_type": "Additional Company Number"
}
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/devices/:deviceId/line_keys' -H 'Accept: application/json'
ENDPOINTS