Location Call Settings - List Locations Webex Calling Details

List Locations Webex Calling Details

Lists Webex Calling locations for an organization with Webex Calling details.

Searching and viewing locations with Webex Calling details in your organization require an administrator auth token with the spark-admin:telephony_config_read scope.

GET/v1/telephony/config/locations

Query Parameters

orgId

string

List locations for this organization.

max

number

Limit the maximum number of locations in the response.

start

number

Specify the offset from the first result that you want to fetch.

name

string

List locations whose name contains this string.

order

string

Sort the list of locations based on name, either asc or desc.

Response Properties

locations

array[ListLocationObject]

Array of locations.

string

A unique identifier for the location.

name

string

The name of the location.

outsideDialDigit

string

Must dial to reach an outside line, default is None.

enforceOutsideDialDigit

boolean

True when enforcing outside dial digit at location level to make PSTN calls.

routingPrefix

string

Must dial a prefix when calling between locations having the same extension within the same location.

callingLineId

object

Location calling line information.

name

string

Group calling line ID name. By default the Org name.

phoneNumber

string

Directory Number / Main number in E.164 Format.

e911SetupRequired

boolean

True if E911 setup is required.

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/locations{?orgId,max,start,name,order}

Header

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

Query Parameters

orgId
string
List locations for this organization.
max
number
Limit the maximum number of locations in the response.
start
number
Specify the offset from the first result that you want to fetch.
name
string
List locations whose name contains this string.
order
string
Sort the list of locations based on `name`, either asc or desc.

https://webexapis.com/v1/telephony/config/locations?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&max=100&start=0&name=Denver&order=name-asc

200 / OK

{
    "locations": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YyZmUzOGVkLTNmNGYtNGI1NC04M2YzLTk4MDg3MWQzMjM5Yw",
            "name": "Denver",
            "routingPrefix": "3",
            "outsideDialDigit": "1258",
            "callingLineId": {
                "phoneNumber": "+12145556985"
            },
            "e911SetupRequired": false,
            "enforceOutsideDialDigit": true
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzljYzc0NDgxLTk3ZjAtNDA1NS1iYTIxLWE0NDBkMjUzZTc3OA",
            "name": "Denver-2",
            "routingPrefix": "234",
            "outsideDialDigit": "12",
            "callingLineId": {
                "name": "Denver Incoming",
                "phoneNumber": null
            },
            "e911SetupRequired": false,
            "enforceOutsideDialDigit": false
        }
    ]
}