Webex Location Call Settings API
The Location Call Settings API from Webex — 28 operation(s) for location call settings.
Webex Location Call Settings API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Location Call Settings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 38 operations across 28 paths, and defines 67 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
38 operations
28 paths
67 schemas
1 DELETE22 GET9 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Webex Location Call Settings API declares
3 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
It accepts HTTP bearer tokens (JWT) (bearer-key).
It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.
bearer-key— e.g. Bearer YOURAUTHORIZATIONTOKENbearerAuth— OAuth 2.0 Bearer token authentication
Paths & Operations 38
Across 28 paths, the API surfaces 38 operations — 1 DELETE, 22 GET, 9 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
Location Call Settings 38
GET
/telephony/config/premisePstn/dialPlans/{dialPlanId}/dialPatterns
Read the List of Dial Patterns
GET
/telephony/config/locations
List Locations Webex Calling Details
POST
/telephony/config/locations
Enable a Location for Webex Calling
GET
/telephony/config/locations/{locationId}
Get Location Webex Calling Details
PUT
/telephony/config/locations/{locationId}
Update Location Webex Calling Details
GET
/telephony/config/jobs/updateRoutingPrefix
Get a List of Update Routing Prefix jobs
GET
/telephony/config/jobs/updateRoutingPrefix/{jobId}
Get the job status of Update Routing Prefix job
GET
/telephony/config/jobs/updateRoutingPrefix/{jobId}/errors
Get job errors for update routing prefix job
POST
/telephony/config/locations/{locationId}/actions/modifyAnnouncementLanguage/invoke
Change Announcement Language
GET
/telephony/config/locations/{locationId}/features/emergencyCallbackNumber
Get a Location Emergency callback number
PUT
/telephony/config/locations/{locationId}/features/emergencyCallbackNumber
Update a Location Emergency callback number
POST
/telephony/config/actions/validateExtensions/invoke
Validate the List of Extensions
POST
/telephony/config/locations/{locationId}/actions/validateExtensions/invoke
Validate Extensions
PUT
/telephony/config/locations/{locationId}/musicOnHold
Update Music On Hold
GET
/telephony/config/locations/{locationId}/musicOnHold
Get Music On Hold
GET
/telephony/config/locations/{locationId}/privateNetworkConnect
Get Private Network Connect
PUT
/telephony/config/locations/{locationId}/privateNetworkConnect
Update Private Network Connect
GET
/telephony/config/routeChoices
Read the List of Routing Choices
GET
/telephony/config/locations/{locationId}/externalCallerId/availableNumbers
Get the List of Phone Numbers Available for External Caller ID
GET
/telephony/config/locations/{locationId}/availableNumbers
Get Available Phone Numbers for a Location with Given Criteria
GET
/telephony/config/locations/{locationId}/webexGo/availableNumbers
Get Webex Go Available Phone Numbers
GET
/telephony/config/locations/{locationId}/emergencyCallbackNumber/availableNumbers
Get Location ECBN Available Phone Numbers
GET
/telephony/config/locations/{locationId}/callIntercept/availableNumbers
Get Location Call Intercept Available Phone Numbers
POST
/telephony/config/locations/{locationId}/receptionistContacts/directories
Create a Receptionist Contact Directory
GET
/telephony/config/locations/{locationId}/receptionistContacts/directories
Read list of Receptionist Contact Directories
GET
/telephony/config/locations/{locationId}/receptionistContacts/directories/{directoryId}
Get details for a Receptionist Contact Directory
DELETE
/telephony/config/locations/{locationId}/receptionistContacts/directories/{directoryId}
Delete a Receptionist Contact Directory
PUT
/telephony/config/locations/{locationId}/receptionistContacts/directories/{directoryId}
Modify a Receptionist Contact Directory
GET
/telephony/config/locations/{locationId}/chargeNumber/availableNumbers
Get Available Charge Numbers for a Location with Given Criteria
POST
/telephony/config/jobs/locations/deleteCallingLocation
Disable a Location for Webex Calling
GET
/telephony/config/jobs/locations/deleteCallingLocation
Get a List of Disable Calling Location Jobs
POST
/telephony/config/locations/{locationId}/actions/precheckForDeletion/invoke
Safe Delete Check Before Disabling a Location for Webex Calling
POST
/telephony/config/jobs/locations/deleteCallingLocation/{jobId}/actions/pause/invoke
Pause a Disable Calling Location Job
POST
/telephony/config/jobs/locations/deleteCallingLocation/{jobId}/actions/resume/invoke
Resume a Paused Disable Calling Location Job
GET
/telephony/config/jobs/locations/deleteCallingLocation/{jobId}/errors
Retrieve Errors for a Disable Calling Location Job
GET
/telephony/config/jobs/locations/deleteCallingLocation/{jobId}
Get Disable Calling Location Job Status
GET
/telephony/config/locations/{locationId}/callCaptions
Get the location call captions settings
PUT
/telephony/config/locations/{locationId}/callCaptions
Update the location call captions settings
Schemas 67
The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are GetTelephonyLocationObject (15 properties), NumberObject (14 properties), BatchResponse (11 properties), DisableCallingLocationJobStatus (11 properties). Each schema is shown below with its type and property counts.
LocationCallInterceptAvailableNumberListGetObject
object
1 property
1 required
BatchResponse
object
11 properties
9 required
NumberOwnerType
string
PLACE - PSTN phone number's owner is a workspace. PEOPLE - PSTN phone number's owner is a person. VIRTUALLINE - PSTN phone number's owner is a Virtual Profile.…
WebexGoAvailableNumberObject
object
5 properties
5 required
DisableCallingLocationJobStatus
object
Status and details of a disable calling location job.
11 properties
GetMusicOnHoldObject
object
4 properties
3 required
PostValidateExtensionResponse
object
2 properties
2 required
PutMusicOnHoldObject
object
3 properties
PutTelephonyLocationObject
object
9 properties
SafeDeleteCheckForDisableCallingLocationResponse
object
Response from safe delete check operation for disabling a calling location.
4 properties
GetLocationCallBackNumberObject
object
4 properties
4 required
ErrorBean
object
Represents an error that occurred during disable calling location operations.
5 properties
ContactPayloadForModify
object
2 properties
2 required
LocationAvailableNumberObject
object
7 properties
6 required
Error
object
2 properties
extentionStatusObject
object
4 properties
2 required
StepExecutionStatuses
object
8 properties
1 required
AudioAnnouncementFileObject
object
4 properties
RouteType
string
ROUTEGROUP - Route group must include at least one trunk with a maximum of 10 trunks per route group. TRUNK - Connection between Webex Calling and the premises.
ListLocationObject
object
7 properties
4 required
UpdateLocationCallCaptionsObject
object
3 properties
AudioAnnouncementFileGetObject
object
4 properties
4 required
CallBackSelected
string
LOCATIONNUMBER - Location TN. LOCATIONMEMBERNUMBER - Assigned number of a user, workspace, virtual line or hunt group in the location.
CallBackQuality
string
RECOMMENDED - An activated number, associated with a User or Workspace. NOTRECOMMENDED - An activated number, associated with anything else, like Auto Attendan…
GetTelephonyLocationObject
object
15 properties
10 required
StatusOfExtensionsObject
object
2 properties
1 required
GetPrivateNetworkConnectObject
object
1 property
1 required
LocationCallInterceptAvailableNumberObject
object
8 properties
6 required
NumberObject
object
14 properties
6 required
PostLocationAnnouncementLanguageObject
object
3 properties
1 required
PaginatedResult
object
Paginated response containing error items for disable calling location operations.
1 property
RouteIdentity
object
3 properties
3 required
PostLocationCallingRequest
object
6 properties
6 required
CallBackMemberType
string
PEOPLE - Associated member is a person. PLACE - Associated member is a workspace. VIRTUALLINE - Associated member is a virtual line. HUNTGROUP - Associated mem…
BlockingUnlessForcedDisableCallingLocation
object
Reasons that block disabling a calling location
2 properties
CallBackEffectiveLevel
string
LOCATIONNUMBER - Location TN. LOCATIONMEMBERNUMBER - Assigned number of a user, workspace, virtual line or hunt group in the location. NONE - When no other opt…
ArrayOfExtensionsObject
object
1 property
1 required
LocationAvailableChargeNumberObject
object
A phone number that is available to be assigned as the location's charge number.
6 properties
5 required
LocationAvailableNumberListGetObject
object
1 property
1 required
WebexGoAvailableNumberListGetObject
object
1 property
1 required
BatchJobError
object
3 properties
LocationDeleteStatus
string
BLOCKED - Disable Webex Calling location operation is blocked and cannot proceed. UNBLOCKED - Disable Webex Calling location operation can proceed without any…
NonBlockingDisableCallingLocation
object
Non blocking reasons for disabling a calling location that do not prevent the operation from proceeding
1 property
PersonId
object
3 properties
DisableCallingLocationCounts
object
Counts of various account types processed during disable calling location operation.
6 properties
ContactPayload
object
2 properties
2 required
ErrorMessage
object
3 properties
1 required
LocationECBNAvailableNumberObject
object
7 properties
6 required
ErrorType
string
WARN - A warning message that doesn't block the operation. ERROR - An error message that indicates a failure in the operation.
BlockingDisableCallingLocation
object
Factors that completely block disabling a calling location.
6 properties
PutLocationCallBackNumberObject
object
3 properties
2 required
STATE
string
ACTIVE - Phone number is in the active state. INACTIVE - Phone number is in the inactive state.
LocationECBNAvailableNumberListGetObject
object
1 property
1 required
Counts
object
2 properties
2 required
PostValidateExtension
object
1 property
ContactDetails
object
8 properties
8 required
Directory
object
2 properties
2 required
JobExecutionStatus
object
8 properties
1 required
ExternalCallerIdNumberListGet
object
1 property
1 required
DisableCallingLocationPostRequest
object
Request body for disabling a calling location.
3 properties
1 required
GetLocationCallCaptionsObject
object
5 properties
5 required
LocationCallingResponseWithId
object
1 property
1 required
LocationAvailableChargeNumberListGetObject
object
1 property
1 required
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
ExtensionStatusObject
object
4 properties
1 required
LocationPUTResponse
object
2 properties
PutPrivateNetworkConnectObject
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Webex 12
Other APIs Webex publishes across the network.
Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API
#Location Call Settings