Zoom Public API Documentation
List tracked locations
GET {{baseUrl}}/phone/metrics/location_tracking?type=5&site_id=<string>&location_type=unknown&keyword=<string>
Lists the tracked locations. Prerequisites:
* Pro or higher account plan with Zoom phone license
* Account owner or admin permissions Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_tracked_locations:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
type
|
number | The type of response data. Supports only six responses at this time. `1`: Nomadic Emergency Services. `2`: Users Permission for Location Sharing. `3`: Default Emergency Address. `4`: Detectable Personal Location. `5`: Real-time Location for Users. `6`: Real-time Location for IP Phones. | |
site_id
|
string | The site's ID. | |
location_type
|
string | The location's type. 'Company' is the default value. | |
keyword
|
string | The device name or device MAC address. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"location_tracking": [
{
"assignees": [
{
"extension_number": "<long>",
"id": "<string>",
"name": "<string>"
},
{
"extension_number": "<long>",
"id": "<string>",
"name": "<string>"
}
],
"city": "<string>",
"country": "<string>",
"device": {
"bssid": "<string>",
"id": "<string>",
"mac_address": "<string>",
"name": "<string>",
"private_ip": "<string>",
"public_ip": "<string>"
},
"emergency_address": "<string>",
"name": "<string>",
"network_switch": {
"mac_address": "<string>",
"port": "<string>"
},
"site": {
"id": "<string>",
"name": "<string>"
},
"type": "company",
"zip": "<string>"
},
{
"assignees": [
{
"extension_number": "<long>",
"id": "<string>",
"name": "<string>"
},
{
"extension_number": "<long>",
"id": "<string>",
"name": "<string>"
}
],
"city": "<string>",
"country": "<string>",
"device": {
"bssid": "<string>",
"id": "<string>",
"mac_address": "<string>",
"name": "<string>",
"private_ip": "<string>",
"public_ip": "<string>"
},
"emergency_address": "<string>",
"name": "<string>",
"network_switch": {
"mac_address": "<string>",
"port": "<string>"
},
"site": {
"id": "<string>",
"name": "<string>"
},
"type": "company",
"zip": "<string>"
}
],
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/metrics/location_tracking?type=5&site_id=<string>&location_type=unknown&keyword=<string>?type=5&site_id=<string>&location_type=unknown&keyword=<string>' -H 'Accept: application/json'
ENDPOINTS