Automatic Location Updates

Get Emergency Location

Returns emergency response location by ID. Available for Admin users only.

get/restapi/v1.0/account/{accountId}/emergency-locations/{locationId}

Request

Base URL
https://platform.ringcentral.com
Auth
OAuth 2
Authorization codehttps://platform.ringcentral.com/restapi/oauth/authorize
Token URLhttps://platform.ringcentral.com/restapi/oauth/token
TypeScript
https://skmtc.dev/ringcentral/apis/ringcentral-api/docs/restapi/v1.0/account/:accountId/emergency-locations/:locationId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

locationIdstring required

Internal identifier of an emergency response location

Query parameters

syncEmergencyAddressboolean

Response

Emergency location information

idstring

Internal identifier of an emergency response location

namestring

Emergency response location name

addressStatus'Valid' | 'Invalid' | 'Provisioning'

Emergency address status

usageStatus'Active' | 'Inactive'

Status of emergency response location usage.

Resulting status of emergency address synchronization. Returned if syncEmergencyAddress parameter is set to true

addressType'LocationWithElins' | 'LocationWithEndpoint'

visibility'Private' | 'Public'

Visibility of an emergency response location. If Private is set, then location is visible only for the restricted number of users, specified in owners array

addressFormatIdstring

Address format ID

Changes

No recorded changes to this operation across all 1 revision of this API.