Webex Call Routing API
The Call Routing API from Webex — 28 operation(s) for call routing.
Webex Call Routing API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Call Routing. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 46 operations across 28 paths, and defines 84 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
46 operations
28 paths
84 schemas
6 DELETE23 GET9 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Webex Call Routing 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 46
Across 28 paths, the API surfaces 46 operations — 6 DELETE, 23 GET, 9 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
Call Routing 46
POST
/telephony/config/actions/testCallRouting/invoke
Test Call Routing
GET
/telephony/config/premisePstn/trunks/{trunkId}/usageDialPlan
Get Local Gateway Dial Plan Usage for a Trunk
GET
/telephony/config/premisePstn/trunks/{trunkId}/usagePstnConnection
Get Locations Using the Local Gateway as PSTN Connection Routing
GET
/telephony/config/premisePstn/trunks/{trunkId}/usageRouteGroup
Get Route Groups Using the Local Gateway
GET
/telephony/config/premisePstn/trunks/{trunkId}/usage
Get Local Gateway Usage Count
PUT
/telephony/config/premisePstn/dialPlans/{dialPlanId}/dialPatterns
Modify Dial Patterns
POST
/telephony/config/premisePstn/actions/validateDialPatterns/invoke
Validate a Dial Pattern
GET
/telephony/config/premisePstn/dialPlans
Read the List of Dial Plans
POST
/telephony/config/premisePstn/dialPlans
Create a Dial Plan
GET
/telephony/config/premisePstn/dialPlans/{dialPlanId}
Get a Dial Plan
PUT
/telephony/config/premisePstn/dialPlans/{dialPlanId}
Modify a Dial Plan
DELETE
/telephony/config/premisePstn/dialPlans/{dialPlanId}
Delete a Dial Plan
POST
/telephony/config/premisePstn/trunks/actions/fqdnValidation/invoke
Validate Local Gateway FQDN and Domain for a Trunk
GET
/telephony/config/premisePstn/trunks
Read the List of Trunks
POST
/telephony/config/premisePstn/trunks
Create a Trunk
GET
/telephony/config/premisePstn/trunks/{trunkId}
Get a Trunk
PUT
/telephony/config/premisePstn/trunks/{trunkId}
Modify a Trunk
DELETE
/telephony/config/premisePstn/trunks/{trunkId}
Delete a Trunk
GET
/telephony/config/premisePstn/trunks/trunkTypes
Read the List of Trunk Types
GET
/telephony/config/premisePstn/routeGroups
Read the List of Routing Groups
POST
/telephony/config/premisePstn/routeGroups
Create Route Group for a Organization
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}
Read a Route Group for a Organization
PUT
/telephony/config/premisePstn/routeGroups/{routeGroupId}
Modify a Route Group for a Organization
DELETE
/telephony/config/premisePstn/routeGroups/{routeGroupId}
Remove a Route Group from an Organization
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usage
Read the Usage of a Routing Group
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageCallToExtension
Read the Call to Extension Locations of a Routing Group
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageDialPlan
Read the Dial Plan Locations of a Routing Group
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usagePstnConnection
Read the PSTN Connection Locations of a Routing Group
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageRouteList
Read the Route Lists of a Routing Group
GET
/telephony/config/premisePstn/routeLists
Read the List of Route Lists
POST
/telephony/config/premisePstn/routeLists
Create a Route List
DELETE
/telephony/config/premisePstn/routeLists/{routeListId}
Delete a Route List
GET
/telephony/config/premisePstn/routeLists/{routeListId}
Get a Route List
PUT
/telephony/config/premisePstn/routeLists/{routeListId}
Modify a Route List
PUT
/telephony/config/premisePstn/routeLists/{routeListId}/numbers
Modify Numbers for Route List
GET
/telephony/config/premisePstn/routeLists/{routeListId}/numbers
Get Numbers assigned to a Route List
GET
/telephony/config/premisePstn/trunks/{trunkId}/usageCallToExtension
Get Local Gateway Call to On-Premises Extension Usage for a Trunk
POST
/telephony/config/callRouting/translationPatterns
Create a Translation Pattern for an Organization
GET
/telephony/config/callRouting/translationPatterns
Retrieve the list of Translation Patterns
GET
/telephony/config/callRouting/translationPatterns/{translationId}
Retrieve a specific Translation Pattern for an Organization
PUT
/telephony/config/callRouting/translationPatterns/{translationId}
Modify a specific Translation Pattern for an Organization
DELETE
/telephony/config/callRouting/translationPatterns/{translationId}
Delete a specific Translation Pattern
POST
/telephony/config/locations/{locationId}/callRouting/translationPatterns
Create a Translation Pattern for a Location
GET
/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Retrieve a specific Translation Pattern for a Location
PUT
/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Modify a specific Translation Pattern for a Location
DELETE
/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Delete a specific Translation Pattern for a Location
Schemas 84
The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are TrunkGet (21 properties), TestCallRoutingPostResponse (18 properties), VirtualExtension (14 properties), VirtualExtensionRange (12 properties). Each schema is shown below with its type and property counts.
FeatureAccessCode
object
Details of a feature access code configured for services that are assigned to the authenticated user.
3 properties
2 required
CallInterceptDetails
object
3 properties
2 required
DialPatternValidationStatus
string
ERRORS - In case one or more dial pattern validation failed OK - If all the patterns are validated successfully
DialPlan
object
5 properties
5 required
TranslationPatternItem
object
6 properties
5 required
Trunk
object
6 properties
2 required
OutgoingCallingPlanPermissionsByDigitPattern
object
7 properties
4 required
TrunkGet
object
21 properties
6 required
RouteList
object
6 properties
6 required
RouteGroupUsageRouteListItem
object
4 properties
4 required
ResponseStatusType
string
ERROR - Error WARNING - Warning
TrunkFQDNValidatePost
object
3 properties
TranslationPatternGetList
object
1 property
1 required
ResponseStatus
object
5 properties
5 required
TrunkType
string
REGISTERING - For Cisco CUBE Local Gateway. CERTIFICATEBASED - For Cisco Unified Border Element, Oracle ACME Session Border Controller, AudioCodes Session Bord…
LocationTranslationPatternCreateRequest
object
3 properties
3 required
Organization
object
2 properties
2 required
TranslationPatternCreateRequest
object
3 properties
3 required
DialPatternValidateResult
object
2 properties
OutgoingCallingPlanPermissionsByType
object
6 properties
1 required
TrunkTypeWithDeviceType
object
2 properties
2 required
DeviceType
string
DEVICE - The endpoint is a device. APPLICATION - The endpoint is a application.
RouteGroupGet
object
3 properties
3 required
CallDestinationType
string
HOSTEDAGENT - A destination is a person or workspace with details in the hostedAgent field. HOSTEDFEATURE - Destination is a calling feature like auto-attendan…
HostedFeature
object
7 properties
5 required
VirtualExtensionRange
object
12 properties
3 required
UnknownExtension
object
6 properties
PstnNumber
object
6 properties
RouteListGet
object
3 properties
2 required
TranslationPatternGet
object
4 properties
4 required
RouteGroupPost
object
2 properties
2 required
PbxUser
object
9 properties
3 required
RouteListPost
object
3 properties
3 required
CallingPermissionAction
string
ALLOW - Allow the designated call type. BLOCK - Block the designated call type. AUTHCODE - Allow only via Authorization Code. TRANSFERNUMBER1 - Transfer to Aut…
RouteGroup
object
3 properties
3 required
OriginatorType
string
PEOPLE - The originator type object is a person. TRUNK - Connection between Webex Calling and the premises.
NumberStatus
string
RouteGroupUsageRouteListGet
object
1 property
RouteListNumberPatchResponse
object
3 properties
3 required
Location
object
Details of the location for the assigned assistant.
2 properties
2 required
TrunkTypeGetList
object
1 property
1 required
Emergency
object
7 properties
1 required
RouteListNumberPatch
object
2 properties
2 required
DialPatternStatus
string
INVALID - Invalid pattern DUPLICATE - Duplicate pattern DUPLICATEINLIST - Duplicate in input
RouteListPatch
object
2 properties
DialPlanGet
object
6 properties
6 required
TranslationPatternModifyRequest
object
3 properties
DialPatternValidate
object
3 properties
DialPlanUsageGetResponse
object
2 properties
2 required
TestCallRoutingPostResponse
object
18 properties
3 required
RouteListNumberListGet
object
1 property
1 required
TrunkPut
object
5 properties
2 required
VirtualExtension
object
14 properties
4 required
LocationTranslationPatternModifyRequest
object
3 properties
DialPatternAction
string
ADD - Add action, when adding a new dial pattern DELETE - Delete action, when deleting an existing dial pattern
LocalGateways
object
4 properties
2 required
Customer
object
2 properties
2 required
PostResponse
object
1 property
1 required
ConfigurationLevelType
string
LOCATION - The applied services at the location level. PEOPLE - The applied services at the people level. PLACE - The applied services at the place level. VIRT…
ActionOnRouteList
string
ADD - Add a phone number to the Route List. DELETE - Delete a phone number from the Route List.
DialPattern
object
2 properties
DeviceStatus
string
ONLINE - Device is online OFFLINE - Device is offline UNKNOWN - Unknown. Default
CallingPlanReason
string
FRAUDCONTAINMENT - Calling plan gives the Fraud Containment reason. CISCOCALLINGPLAN - The Cisco calling plan reason. TRANSFERNUMBER1NOTCONFIGURED - The reason…
ServiceType
string
AUTOATTENDANT - The destination is an auto attendant. BROADWORKSANYWHERE - The destination is the Office (Broadworks) Anywhere feature. CALLQUEUE - The destina…
CallSourceInfo
object
6 properties
1 required
AppliedServices
object
4 properties
TrunkPost
object
11 properties
4 required
RouteGroupUsageGetResponse
object
3 properties
3 required
LocationTranslationPatternGet
object
4 properties
4 required
HostedAgentType
string
PEOPLE - This object is a person. PLACE - A workspace that is not assigned to a specific person such as for a shared device in a common area.
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.
DialPlanPut
object
3 properties
3 required
RouteGroupPatch
object
2 properties
2 required
PChargeInfoSupportPolicyType
string
DISABLED - The P-Charge-Info header support policy is disabled. ASSERTEDIDENTITY - The P-Charge-Info header is always included in outbound PSTN calls using Web…
TranslationPattern
object
6 properties
Repair
object
6 properties
UnknownNumber
object
6 properties
RouteListListGet
object
6 properties
4 required
LocalGatewayUsageCount
object
4 properties
4 required
CallSourceType
string
ROUTELIST - Route list is a type of call source. DIALPATTERN - Dial pattern is a type of call source. UNKOWNEXTENSION - The call source extension is unknown. U…
HostedAgent
object
8 properties
6 required
ResponseId
object
Response object that contains the unique identifier for the created or updated criteria.
1 property
DialPatternPut
object
2 properties
DialPlanPost
object
4 properties
3 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
#Call Routing