Webex Calling Emergency Services Settings - Get a Workspace Emergency Callback Number

Get a Workspace Emergency Callback Number

Retrieve the emergency callback number setting associated with a specific workspace.

Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) and Emergency Service Addresses to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.

To retrieve an emergency callback number, it requires a full, location, user, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/workspaces/{workspaceId}/emergencyCallbackNumber

URI Parameters

workspaceId

stringrequired

Retrieve Emergency Callback Number attributes for this workspace.

Query Parameters

orgId

string

Retrieve Emergency Callback Number attributes for this organization.

Response Properties

selected

ECBNSelectionType

Selected number type to configure emergency call back.

DIRECT_LINE

string

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.

LOCATION_ECBN

string

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.

LOCATION_MEMBER_NUMBER

string

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.

NONE

string

When no other option is selected.

directLineInfo

object

Data relevant to the ECBN for this user/location/virtual line/hunt group.

phoneNumber

string

The callback phone number that is associated with the direct line.

firstName

string

First name of a user.

lastName

string

Last name of a user.

effectiveLevel

ECBNDirectLineEffectiveLevelType

The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.

DIRECT_LINE

string

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.

LOCATION_ECBN

string

LOCATION_NUMBER

string

A location’s main number that is suitable for when the location has a single building with a single floor.

NONE

string

There is no effective level type selected.

effectiveValue

string

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.

quality

ECBNQualityType

Used to represent whether a number is a recommended ECBN.

RECOMMENDED

string

The emergency callback number is assigned to a user or workspace or virtual line.

NOT_RECOMMENDED

string

The emergency callback number is assigned to something that may not be an attended destination.

INVALID

string

The emergency callback number is a number where callbacks would never work, i.e., no available caller ID.

locationECBNInfo

object

Data relevant to the user/place/virtual line/hunt group selected for ECBN for this location.

phoneNumber

string

The callback phone number that is associated with the location's ECBN configuration.

lastName

string

Last name of the user or location member or ..

effectiveLevel

ECBNDirectLineEffectiveLevelType

The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.

DIRECT_LINE

string

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.

LOCATION_ECBN

string

LOCATION_NUMBER

string

A location’s main number that is suitable for when the location has a single building with a single floor.

NONE

string

There is no effective level type selected.

effectiveValue

string

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.

quality

ECBNQualityType

Used to represent whether a number is a recommended ECBN.

RECOMMENDED

string

The emergency callback number is assigned to a user or workspace or virtual line.

NOT_RECOMMENDED

string

The emergency callback number is assigned to something that may not be an attended destination.

INVALID

string

The emergency callback number is a number where callbacks would never work, i.e., no available caller ID.

firstName

string

First name of the user or location member or group name.

locationMemberInfo

object

Data relevant to the user/place/virtual line/hunt group selected for ECBN.

phoneNumber

string

The callback phone number that is associated with member configured for the location ECBN.

firstName

string

First name of a user.

lastName

string

Last name of the user or location member or ..

memberId

string

Member ID of user/place/virtual line/hunt group within the location.

effectiveLevel

LocationMemberInfoEffectiveLevelType

The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.

DIRECT_LINE

string

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.

LOCATION_ECBN

string

LOCATION_NUMBER

string

A location’s main number that is suitable for when the location has a single building with a single floor.

LOCATION_MEMBER_NUMBER

string

NONE

string

When no other option is selected.

effectiveValue

string

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.

quality

ECBNQualityType

Used to represent whether a number is a recommended ECBN.

RECOMMENDED

string

The emergency callback number is assigned to a user or workspace or virtual line.

NOT_RECOMMENDED

string

The emergency callback number is assigned to something that may not be an attended destination.

INVALID

string

The emergency callback number is a number where callbacks would never work, i.e., no available caller ID.

memberType

MemberType

Type of the member.

PEOPLE

string

Associated member is a person.

PLACE

string

Associated member is a workspace.

VIRTUAL_LINE

string

Associated member is a virtual line.

HUNT_GROUP

string

Associated member is a hunt group.

defaultInfo

object

Gives Emergency Callback Number effective value when none of the above is assigned or some other value is set behind the scene.

effectiveValue

string

The field contains the ECBN number.

quality

ECBNQualityType

Used to represent whether a number is a recommended ECBN.

RECOMMENDED

string

The emergency callback number is assigned to a user or workspace or virtual line.

NOT_RECOMMENDED

string

The emergency callback number is assigned to something that may not be an attended destination.

INVALID

string

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.

GET

/v1/telephony/config/workspaces//emergencyCallbackNumber{?orgId}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
Retrieve Emergency Callback Number attributes for this organization.

https://webexapis.com/v1/telephony/config/workspaces/Y2lzY29zcGFyazovL3VzL1BMQUNFLzBjZWViMWZjLThmYTItNDk4YS1hYzc2LTY3YzJkZDcwZDZk/emergencyCallbackNumber?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM

200 / OK

{
        "selected": "DIRECT_LINE",
        "directLineInfo": {
            "phoneNumber": "+18164196065",
            "firstName": "backUpworkspace",
            "lastName": ".",
            "effectiveLevel": "DIRECT_LINE",
            "effectiveValue": "+18164196065",
            "quality": "RECOMMENDED"
        },
        "locationECBNInfo": {
            "phoneNumber": "+18164196065",
            "lastName": ".",
            "effectiveLevel": "DIRECT_LINE",
            "effectiveValue": "+18164196065",
            "quality": "RECOMMENDED",
            "firstName": "backUpworkspace"
        },
        "locationMemberInfo": {
            "phoneNumber": "+18164196065",
            "firstName": "backUpworkspace",
            "lastName": ".",
            "memberId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8wY2VlYjFmYy04ZmEyLTQ5OGEtYWM3Ni02N2MyZGQ3MGQ2ZGY=",
            "effectiveLevel": "LOCATION_MEMBER_NUMBER",
            "effectiveValue": "+18164196065",
            "quality": "RECOMMENDED",
            "memberType": "PLACE"
        }
    }