Zoom Public API Documentation
List tracked locations
GET {{baseUrl}}/phone/metrics/location_tracking?type=6&site_id=NjHmTu16Qfe8yOiNJuekXA&location_type=personal&keyword=device name
Use this API to list tracked locations. Prerequisites:
* Pro or higher account plan with Zoom phone license
* Account owner or admin permissions Scope: Rate Limit Label: phone:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
type
|
number | The type of response data. Supports '6' only 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' being the default value. | |
keyword
|
string | Device name or device mac address. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"location_tracking": [
{
"assignees": [
{
"extension_number": 10010,
"id": "IqoQmDRqS-aIoXqV_FZ88w",
"name": "testUser"
},
{
"extension_number": 10010,
"id": "IqoQmDRqS-aIoXqV_FZ88w",
"name": "testUser"
}
],
"city": "SAN JOSE",
"country": "US",
"device": {
"bssid": "SA43YjfBTS6gJbUpfvIziQ",
"id": "-tDdYIstSumpA0L13GztIQ",
"mac_address": "543968a78ee7",
"name": "Desk Phone",
"private_ip": "192.168.1.1",
"public_ip": "192.168.1.1"
},
"emergency_address": "55 ALMADEN BLVD",
"name": "testLocation",
"network_switch": {
"mac_address": "543968a78ee7",
"port": "2"
},
"site": {
"id": "NjHmTu16Qfe8yOiNJuekXA",
"name": "testSite"
},
"type": "personal",
"zip": "95113"
},
{
"assignees": [
{
"extension_number": 10010,
"id": "IqoQmDRqS-aIoXqV_FZ88w",
"name": "testUser"
},
{
"extension_number": 10010,
"id": "IqoQmDRqS-aIoXqV_FZ88w",
"name": "testUser"
}
],
"city": "SAN JOSE",
"country": "US",
"device": {
"bssid": "SA43YjfBTS6gJbUpfvIziQ",
"id": "-tDdYIstSumpA0L13GztIQ",
"mac_address": "543968a78ee7",
"name": "Desk Phone",
"private_ip": "192.168.1.1",
"public_ip": "192.168.1.1"
},
"emergency_address": "55 ALMADEN BLVD",
"name": "testLocation",
"network_switch": {
"mac_address": "543968a78ee7",
"port": "2"
},
"site": {
"id": "NjHmTu16Qfe8yOiNJuekXA",
"name": "testSite"
},
"type": "personal",
"zip": "95113"
}
],
"next_page_token": "T6WMY4fJBIAlxPUiqRtwvQS9dvsq8AoRam2",
"page_size": 30,
"total_records": 1
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/metrics/location_tracking?type=6&site_id=NjHmTu16Qfe8yOiNJuekXA&location_type=personal&keyword=device name?type=6&site_id=NjHmTu16Qfe8yOiNJuekXA&location_type=personal&keyword=device name' -H 'Accept: application/json'
ENDPOINTS