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
site_id
parameter is required.
Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
Scopes:
phone:read:admin
Granular Scopes:
phone:read:list_emergency_locations:admin
Rate Limit Label
:
LIGHT
Request Params
| 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 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":"\u003cstring\u003e","elin":{"phone_number":"\u003cstring\u003e","phone_number_id":"\u003cstring\u003e"},"id":"\u003cstring\u003e","identifier":"\u003cstring\u003e","name":"\u003cstring\u003e","network_switches":[{"mac_address":"\u003cstring\u003e","port":"\u003cstring\u003e","port_prefix":"\u003cstring\u003e","port_range_from":"\u003cstring\u003e","port_range_to":"\u003cstring\u003e"},{"mac_address":"\u003cstring\u003e","port":"\u003cstring\u003e","port_prefix":"\u003cstring\u003e","port_range_from":"\u003cstring\u003e","port_range_to":"\u003cstring\u003e"}],"parent_location_id":"\u003cstring\u003e","private_ip":"\u003cstring\u003e","public_ip":"\u003cstring\u003e","sip_group":{"display_name":"\u003cstring\u003e","id":"\u003cstring\u003e"},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"emergency_address":{"address_line1":"\u003cstring\u003e","address_line2":"\u003cstring\u003e","city":"\u003cstring\u003e","state_code":"\u003cstring\u003e","country":"\u003cstring\u003e","zip":"\u003cstring\u003e","vat_number":"\u003cstring\u003e"},"minimum_match_criteria":"\u003cboolean\u003e"},{"bssid":"\u003cstring\u003e","elin":{"phone_number":"\u003cstring\u003e","phone_number_id":"\u003cstring\u003e"},"id":"\u003cstring\u003e","identifier":"\u003cstring\u003e","name":"\u003cstring\u003e","network_switches":[{"mac_address":"\u003cstring\u003e","port":"\u003cstring\u003e","port_prefix":"\u003cstring\u003e","port_range_from":"\u003cstring\u003e","port_range_to":"\u003cstring\u003e"},{"mac_address":"\u003cstring\u003e","port":"\u003cstring\u003e","port_prefix":"\u003cstring\u003e","port_range_from":"\u003cstring\u003e","port_range_to":"\u003cstring\u003e"}],"parent_location_id":"\u003cstring\u003e","private_ip":"\u003cstring\u003e","public_ip":"\u003cstring\u003e","sip_group":{"display_name":"\u003cstring\u003e","id":"\u003cstring\u003e"},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"emergency_address":{"address_line1":"\u003cstring\u003e","address_line2":"\u003cstring\u003e","city":"\u003cstring\u003e","state_code":"\u003cstring\u003e","country":"\u003cstring\u003e","zip":"\u003cstring\u003e","vat_number":"\u003cstring\u003e"},"minimum_match_criteria":"\u003cboolean\u003e"}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e"}