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: phone:read:admin
Granular Scopes: phone:read:list_tracked_locations:admin
Rate Limit Label: Medium
Request Params
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":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e"}],"city":"\u003cstring\u003e","country":"\u003cstring\u003e","device":{"bssid":"\u003cstring\u003e","id":"\u003cstring\u003e","mac_address":"\u003cstring\u003e","name":"\u003cstring\u003e","private_ip":"\u003cstring\u003e","public_ip":"\u003cstring\u003e"},"emergency_address":"\u003cstring\u003e","name":"\u003cstring\u003e","network_switch":{"mac_address":"\u003cstring\u003e","port":"\u003cstring\u003e"},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"type":"company","zip":"\u003cstring\u003e"},{"assignees":[{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e"}],"city":"\u003cstring\u003e","country":"\u003cstring\u003e","device":{"bssid":"\u003cstring\u003e","id":"\u003cstring\u003e","mac_address":"\u003cstring\u003e","name":"\u003cstring\u003e","private_ip":"\u003cstring\u003e","public_ip":"\u003cstring\u003e"},"emergency_address":"\u003cstring\u003e","name":"\u003cstring\u003e","network_switch":{"mac_address":"\u003cstring\u003e","port":"\u003cstring\u003e"},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"type":"company","zip":"\u003cstring\u003e"}],"next_page_token":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e"}