Get Location Webex Calling Details
Shows Webex Calling details for a location, by ID.
Specifies the location ID in the locationId parameter in the URI.
Searching and viewing locations in your organization requires an administrator auth token with the spark-admin:telephony_config_read scope.
URI Parameters
Retrieve Webex Calling location attributes for this location.
Query Parameters
Retrieve Webex Calling location attributes for this organization.
Response Properties
A unique identifier for the location.
The name of the location.
Location's phone announcement language.
Location calling line information.
Group calling line ID name. By default the Org name.
Directory Number / Main number in E.164 Format.
Connection details are only returned for local PSTN types of TRUNK or ROUTE_GROUP.
Webex Calling location only suppports TRUNK and ROUTE_GROUP connection type.
Route group must include at least one trunk with a maximum of 10 trunks per route group.
Connection between Webex Calling and the premises.
A unique identifier of route type.
PSTN connection ID given for locations with a PSTN subscription.
External Caller ID Name value. Unicode characters.
Limit on the number of people at the location. Read-Only.
Emergency Location Identifier for a location. Set this field to provide the SIP access network information to the provider which will be used to populate the SIP P-Access-Network-Info header. This is helpful to establish the location of a device when you make an emergency call.
Must dial to reach an outside line, default is None.
True when enforcing outside dial digit at location level to make PSTN calls.
Must dial a prefix when calling between locations having same extension within same location.
IP Address, hostname, or domain. Read-Only.
Chargeable number for the line placing the call. When this is set, all calls placed from this location will include a P-Charge-Info header with the selected number in the SIP INVITE.
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
- Retrieve Webex Calling location attributes for this organization.
{
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw",
"name": "Denver",
"announcementLanguage": "fr_fr",
"routingPrefix": "2",
"callingLineId": {
"name": "Denver Incoming",
"phoneNumber": "+12145555698"
},
"connection": {
"type": "TRUNK",
"id": "Y2lzY29zcGFyazovL3VzL1RSVU5LL2M1MGIxZjY2LTRjODMtNDAzNy04NjM1LTg2ZjlkM2VkZDQ5MQ"
},
"subscriptionId": "trial",
"externalCallerIdName": "Big Corp-Denver",
"userLimit": 500000,
"outsideDialDigit": "12",
"pAccessNetworkInfo": "Richardson-TX",
"defaultDomain": "98079822.int10.bcld.webex.com",
"chargeNumber": "+14158952369",
"enforceOutsideDialDigit": true
}