Get the Virtual Line's Emergency Callback settings
Retrieves the emergency callback number settings for a specific virtual line.
Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users.
Retrieving the dependencies requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Unique identifier for the virtual line.
Query Parameters
List virtual lines for this organization.
Response Properties
Selected number type to configure emergency call back.
Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member's phone is specific to the member’s location.
Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.
Configure one user with another user’s telephone number as an ECBN. This option is used in place of a location’s main number when the location has multiple floors or buildings. This allows the ECBN assigned to have a more accurate Emergency Service Address associated with it.
When no other option is selected.
Data relevant to the ECBN for this user/location/virtual line.
The callback phone number that is associated with the direct line.
First name of a user.
Last name of a user.
The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.
Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member's phone is specific to the member’s location.
Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.
A location’s main number that is suitable for when the location has a single building with a single floor.
There is no effective level type selected.
The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable.
Used to represent whether a number is a recommended ECBN.
The emergency callback number is assigned to a user or workspace or virtual line.
The emergency callback number is assigned to something that may not be an attended destination.
The emergency callback number is a number where callbacks would never work, i.e., no available caller ID.
Data relevant to the user/place/virtual line selected for ECBN for this location.
The callback phone number that is associated with the location's ECBN configuration.
First name for the location. This field will be populated with group name when the effectiveLevel is LOCATION_ECBN or LOCATION_NUMBER.
This field contains the location member's last name when the effectiveLevel is LOCATION_ECBN, the location is using a location member number, and the selected member is a user. This field will always return "." when the effectiveLevel is LOCATION_ECBN, the location is using the location member number, and the selected member is a place.
The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.
Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member's phone is specific to the member’s location.
Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.
A location’s main number that is suitable for when the location has a single building with a single floor.
There is no effective level type selected.
Contains the location-level emergency callback number if valid. If not, contains the user's main number if valid.
Used to represent whether a number is a recommended ECBN.
The emergency callback number is assigned to a user or workspace or virtual line.
The emergency callback number is assigned to something that may not be an attended destination.
The emergency callback number is a number where callbacks would never work, i.e., no available caller ID.
A unique identifier for the location member's PSTN phone number.
First name for the location member.
Last name for the location member. This field will always return "." when effectiveLevel is DIRECT_LINE or LOCATION_MEMBER_NUMBER, and the selected member is a place.
Member ID of user/place/virtual line within the location.
The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.
Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member's phone is specific to the member’s location.
Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.
A location’s main number that is suitable for when the location has a single building with a single floor.
Configure one user with another user’s telephone number as an ECBN. This option is used in place of a location’s main number when the location has multiple floors or buildings. This allows the ECBN assigned to have a more accurate Emergency Service Address associated with it.
When no other option is selected.
Contains the location-level emergency callback number if valid. If not, contains the user's main number if valid.
Used to represent whether a number is a recommended ECBN.
The emergency callback number is assigned to a user or workspace or virtual line.
The emergency callback number is assigned to something that may not be an attended destination.
The emergency callback number is a number where callbacks would never work, i.e., no available caller ID.
Type of the member.
Associated member is a person.
Associated member is a workspace.
Associated member is a virtual line.
Contains the Emergency Callback Number effective value when none of the above parameters are assigned or some other value is set.
The field contains ECBN number.
Used to represent whether a number is a recommended ECBN.
The emergency callback number is assigned to a user or workspace or virtual line.
The emergency callback number is assigned to something that may not be an attended destination.
The emergency callback number is a number where callbacks would never work, i.e., no available caller ID.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- List virtual lines for this organization.
{
"selected": "DIRECT_LINE",
"directLineInfo": {
"phoneNumber": "9726856700",
"firstName": "John",
"lastName": "Smith",
"effectiveLevel": "DIRECT_LINE",
"effectiveValue": "9726856770",
"quality": "RECOMMENDED"
},
"locationECBNInfo": {
"phoneNumber": "9726856701",
"firstName": "Jane",
"lastName": "Smith",
"effectiveLevel": "LOCATION_ECBN",
"effectiveValue": "9726856772",
"quality": "RECOMMENDED"
},
"locationMemberInfo": {
"phoneNumber": "9726856703",
"firstName": "Group Name",
"lastName": ".",
"memberId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MmQ3YTY3MS00YmVlLTQ2MDItOGVkOC1jOTFmNjU5NjcxZGI",
"effectiveLevel": "LOCATION_MEMBER_NUMBER",
"effectiveValue": "9726856774",
"quality": "RECOMMENDED",
"memberType": "PLACE"
}
}