Zoom Public API Documentation
List emergency service locations
GET {{baseUrl}}/phone/locations?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30&site_id=SQv52YtkRLC2dwrDdYtGsA
Use this API to list emergency service locations. Scopes: Prerequisites:
* Pro or a higher account with Zoom Phone license
* Account owner or admin permissionsphone:read:admin
Rate Limit Label: Light
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 | 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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"locations": [
{
"bssid": "SA43YjfBTS6gJbUpfvIziQ",
"elin": {
"phone_number": "+12058945656",
"phone_number_id": "9h5vTQJ0TmyKs0wItZ3JAw"
},
"id": "eRYjZlItQIqlFbCuRA__SQ",
"identifier": "FksDtQDfR9qs3gWXNDsfIw",
"name": "example location",
"network_switches": [
{
"mac_address": "0004f25eec3d",
"port": "23",
"port_prefix": "01",
"port_range_from": "01",
"port_range_to": "02"
},
{
"mac_address": "0004f25eec3d",
"port": "23",
"port_prefix": "01",
"port_range_from": "01",
"port_range_to": "02"
}
],
"parent_location_id": "RTGmTYafRU24RqJunfotSA",
"private_ip": "192.1.1.2",
"public_ip": "192.1.1.1",
"sip_group": {
"display_name": "band width",
"id": "F_WKDH6FRdeddZBcNUlUeA"
},
"site": {
"id": "SQv52YtkRLC2dwrDdYtGsA",
"name": "Main Site"
},
"emergency_address": {
"address_line1": "55 ALMADEN BLVD",
"address_line2": "6th floor",
"city": "SAN JOSE",
"state_code": "CA",
"country": "US",
"zip": "95113",
"vat_number": "123456789B01"
},
"minimum_match_criteria": true
},
{
"bssid": "SA43YjfBTS6gJbUpfvIziQ",
"elin": {
"phone_number": "+12058945656",
"phone_number_id": "9h5vTQJ0TmyKs0wItZ3JAw"
},
"id": "eRYjZlItQIqlFbCuRA__SQ",
"identifier": "FksDtQDfR9qs3gWXNDsfIw",
"name": "example location",
"network_switches": [
{
"mac_address": "0004f25eec3d",
"port": "23",
"port_prefix": "01",
"port_range_from": "01",
"port_range_to": "02"
},
{
"mac_address": "0004f25eec3d",
"port": "23",
"port_prefix": "01",
"port_range_from": "01",
"port_range_to": "02"
}
],
"parent_location_id": "RTGmTYafRU24RqJunfotSA",
"private_ip": "192.1.1.2",
"public_ip": "192.1.1.1",
"sip_group": {
"display_name": "band width",
"id": "F_WKDH6FRdeddZBcNUlUeA"
},
"site": {
"id": "SQv52YtkRLC2dwrDdYtGsA",
"name": "Main Site"
},
"emergency_address": {
"address_line1": "55 ALMADEN BLVD",
"address_line2": "6th floor",
"city": "SAN JOSE",
"state_code": "CA",
"country": "US",
"zip": "95113",
"vat_number": "123456789B01"
},
"minimum_match_criteria": true
}
],
"next_page_token": "T6WMY4fJBIAlxPUiqRtwvQS9dvsq8AoRam2",
"page_size": 30
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/locations?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30&site_id=SQv52YtkRLC2dwrDdYtGsA?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30&site_id=SQv52YtkRLC2dwrDdYtGsA' -H 'Accept: application/json'
ENDPOINTS