Zoom Public API Documentation
List emergency service locations
GET {{baseUrl}}/phone/locations?next_page_token=<string>&page_size=30&site_id=<string>
Returns emergency service locations.
Note: When you enable multiple sites, the Prerequisites:
* Pro or a higher account with Zoom Phone license
* Account owner or admin permissions Scopes: Granular Scopes: Rate Limit Label: site_id parameter is required.phone:read:adminphone:read:list_emergency_locations:adminLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
page_size
|
number | The number of records returned within a single API call. | |
site_id
|
string | The unique identifier of the site. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API. **Note:** When the account has been enabled Multiple Sites, this field is required. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"locations": [
{
"bssid": "<string>",
"elin": {
"phone_number": "<string>",
"phone_number_id": "<string>"
},
"id": "<string>",
"identifier": "<string>",
"name": "<string>",
"network_switches": [
{
"mac_address": "<string>",
"port": "<string>",
"port_prefix": "<string>",
"port_range_from": "<string>",
"port_range_to": "<string>"
},
{
"mac_address": "<string>",
"port": "<string>",
"port_prefix": "<string>",
"port_range_from": "<string>",
"port_range_to": "<string>"
}
],
"parent_location_id": "<string>",
"private_ip": "<string>",
"public_ip": "<string>",
"sip_group": {
"display_name": "<string>",
"id": "<string>"
},
"site": {
"id": "<string>",
"name": "<string>"
},
"emergency_address": {
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"state_code": "<string>",
"country": "<string>",
"zip": "<string>",
"vat_number": "<string>"
},
"minimum_match_criteria": "<boolean>"
},
{
"bssid": "<string>",
"elin": {
"phone_number": "<string>",
"phone_number_id": "<string>"
},
"id": "<string>",
"identifier": "<string>",
"name": "<string>",
"network_switches": [
{
"mac_address": "<string>",
"port": "<string>",
"port_prefix": "<string>",
"port_range_from": "<string>",
"port_range_to": "<string>"
},
{
"mac_address": "<string>",
"port": "<string>",
"port_prefix": "<string>",
"port_range_from": "<string>",
"port_range_to": "<string>"
}
],
"parent_location_id": "<string>",
"private_ip": "<string>",
"public_ip": "<string>",
"sip_group": {
"display_name": "<string>",
"id": "<string>"
},
"site": {
"id": "<string>",
"name": "<string>"
},
"emergency_address": {
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"state_code": "<string>",
"country": "<string>",
"zip": "<string>",
"vat_number": "<string>"
},
"minimum_match_criteria": "<boolean>"
}
],
"next_page_token": "<string>",
"page_size": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/locations?next_page_token=<string>&page_size=30&site_id=<string>?next_page_token=<string>&page_size=30&site_id=<string>' -H 'Accept: application/json'
ENDPOINTS