How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Call Routing API

The Call Routing API from Webex — 28 operation(s) for call routing.

Webex Call Routing API is one of 192 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.2.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.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, HTTP Bearer
Resource Areas
1

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 accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — e.g. Bearer YOURAUTHORIZATIONTOKEN

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
TestCallRouting 1 param body → 200400401403404405409410
GET
/telephony/config/premisePstn/trunks/{trunkId}/usageDialPlan
Get Local Gateway Dial Plan Usage for a Trunk
GetLocalGatewayDialPlanUsageForATrunk 6 params → 200400401403404405409410
GET
/telephony/config/premisePstn/trunks/{trunkId}/usagePstnConnection
Get Locations Using the Local Gateway as PSTN Connection Routing
GetLocationsUsingTheLocalGatewayAsPSTNConnectionRouting 2 params → 200400401403404405409410
GET
/telephony/config/premisePstn/trunks/{trunkId}/usageRouteGroup
Get Route Groups Using the Local Gateway
GetRouteGroupsUsingTheLocalGateway 2 params → 200400401403404405409410
GET
/telephony/config/premisePstn/trunks/{trunkId}/usage
Get Local Gateway Usage Count
GetLocalGatewayUsageCount 2 params → 200400401403404405409410
PUT
/telephony/config/premisePstn/dialPlans/{dialPlanId}/dialPatterns
Modify Dial Patterns
ModifyDialPatterns 2 params body → 204400401403404405409410
POST
/telephony/config/premisePstn/actions/validateDialPatterns/invoke
Validate a Dial Pattern
ValidateADialPattern 1 param body → 200400401403404405409410
GET
/telephony/config/premisePstn/dialPlans
Read the List of Dial Plans
ReadTheListOfDialPlans 7 params → 200400401403404405409410
POST
/telephony/config/premisePstn/dialPlans
Create a Dial Plan
CreateADialPlan 1 param body → 201400401403404405409410
GET
/telephony/config/premisePstn/dialPlans/{dialPlanId}
Get a Dial Plan
GetADialPlan 2 params → 200400401403404405409410
PUT
/telephony/config/premisePstn/dialPlans/{dialPlanId}
Modify a Dial Plan
ModifyADialPlan 2 params body → 204400401403404405409410
DELETE
/telephony/config/premisePstn/dialPlans/{dialPlanId}
Delete a Dial Plan
DeleteADialPlan 2 params → 204400401403404405409410
POST
/telephony/config/premisePstn/trunks/actions/fqdnValidation/invoke
Validate Local Gateway FQDN and Domain for a Trunk
ValidateLocalGatewayFQDNAndDomainForATrunk 1 param body → 204400401403404405409410
GET
/telephony/config/premisePstn/trunks
Read the List of Trunks
ReadTheListOfTrunks 7 params → 200400401403404405409410
POST
/telephony/config/premisePstn/trunks
Create a Trunk
CreateATrunk 1 param body → 201400401403404405409410
GET
/telephony/config/premisePstn/trunks/{trunkId}
Get a Trunk
GetATrunk 2 params → 200400401403404405409410
PUT
/telephony/config/premisePstn/trunks/{trunkId}
Modify a Trunk
ModifyATrunk 2 params body → 204400401403404405409410
DELETE
/telephony/config/premisePstn/trunks/{trunkId}
Delete a Trunk
DeleteATrunk 2 params → 204400401403404405409410
GET
/telephony/config/premisePstn/trunks/trunkTypes
Read the List of Trunk Types
ReadTheListOfTrunkTypes 1 param → 200400401403404405409410
GET
/telephony/config/premisePstn/routeGroups
Read the List of Routing Groups
ReadTheListOfRoutingGroups 5 params → 200400401403404405409410
POST
/telephony/config/premisePstn/routeGroups
Create Route Group for a Organization
CreateRouteGroupForAOrganization 1 param body → 201400401403404405409410
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}
Read a Route Group for a Organization
ReadARouteGroupForAOrganization 2 params → 200400401403404405409410
PUT
/telephony/config/premisePstn/routeGroups/{routeGroupId}
Modify a Route Group for a Organization
ModifyARouteGroupForAOrganization 2 params body → 204400401403404405409410
DELETE
/telephony/config/premisePstn/routeGroups/{routeGroupId}
Remove a Route Group from an Organization
RemoveARouteGroupFromAnOrganization 2 params → 204400401403404405409410
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usage
Read the Usage of a Routing Group
ReadTheUsageOfARoutingGroup 2 params → 200400401403404405409410
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageCallToExtension
Read the Call to Extension Locations of a Routing Group
ReadTheCallToExtensionLocationsOfARoutingGroup 6 params → 200400401403404405409410
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageDialPlan
Read the Dial Plan Locations of a Routing Group
ReadTheDialPlanLocationsOfARoutingGroup 6 params → 200400401403404405409410
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usagePstnConnection
Read the PSTN Connection Locations of a Routing Group
ReadThePSTNConnectionLocationsOfARoutingGroup 6 params → 200400401403404405409410
GET
/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageRouteList
Read the Route Lists of a Routing Group
ReadTheRouteListsOfARoutingGroup 6 params → 200400401403404405409410
GET
/telephony/config/premisePstn/routeLists
Read the List of Route Lists
ReadTheListOfRouteLists 6 params → 200400401403404405409410
POST
/telephony/config/premisePstn/routeLists
Create a Route List
CreateARouteList 1 param body → 201400401403404405409410
DELETE
/telephony/config/premisePstn/routeLists/{routeListId}
Delete a Route List
DeleteARouteList 2 params → 204400401403404405409410
GET
/telephony/config/premisePstn/routeLists/{routeListId}
Get a Route List
GetARouteList 2 params → 200400401403404405409410
PUT
/telephony/config/premisePstn/routeLists/{routeListId}
Modify a Route List
ModifyARouteList 2 params body → 204400401403404405409410
PUT
/telephony/config/premisePstn/routeLists/{routeListId}/numbers
Modify Numbers for Route List
ModifyNumbersForRouteList 2 params body → 200400401403404405409410
GET
/telephony/config/premisePstn/routeLists/{routeListId}/numbers
Get Numbers assigned to a Route List
GetNumbersAssignedToARouteList 6 params → 200400401403404405409410
GET
/telephony/config/premisePstn/trunks/{trunkId}/usageCallToExtension
Get Local Gateway Call to On-Premises Extension Usage for a Trunk
GetLocalGatewayCallToOn-PremisesExtensionUsageForATrunk 6 params → 200400401403404405409410
POST
/telephony/config/callRouting/translationPatterns
Create a Translation Pattern for an Organization
CreateATranslationPatternForAnOrganization 1 param body → 201400401403404405409410
GET
/telephony/config/callRouting/translationPatterns
Retrieve the list of Translation Patterns
RetrieveTheListOfTranslationPatterns 8 params → 200400401403404405409410
GET
/telephony/config/callRouting/translationPatterns/{translationId}
Retrieve a specific Translation Pattern for an Organization
RetrieveASpecificTranslationPatternForAnOrganization 2 params → 200400401403404405409410
PUT
/telephony/config/callRouting/translationPatterns/{translationId}
Modify a specific Translation Pattern for an Organization
ModifyASpecificTranslationPatternForAnOrganization 2 params body → 204400401403404405409410
DELETE
/telephony/config/callRouting/translationPatterns/{translationId}
Delete a specific Translation Pattern
DeleteASpecificTranslationPattern 2 params → 204400401403404405409410
POST
/telephony/config/locations/{locationId}/callRouting/translationPatterns
Create a Translation Pattern for a Location
CreateATranslationPatternForALocation 2 params body → 201400401403404405409410
GET
/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Retrieve a specific Translation Pattern for a Location
RetrieveASpecificTranslationPatternForALocation 3 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Modify a specific Translation Pattern for a Location
ModifyASpecificTranslationPatternForALocation 3 params body → 204400401403404405409410
DELETE
/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Delete a specific Translation Pattern for a Location
DeleteASpecificTranslationPatternForALocation 3 params → 204400401403404405409410

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.

TranslationPatternGetList
object
1 property 1 required
TrunkPost
object
11 properties 4 required
AppliedServices
object
4 properties
ResponseStatusType
string
ERROR - Error WARNING - Warning
VirtualExtensionRange
object
12 properties 3 required
TranslationPatternCreateRequest
object
3 properties 3 required
Customer
object
2 properties 2 required
TrunkType
string
REGISTERING - For Cisco CUBE Local Gateway. CERTIFICATEBASED - For Cisco Unified Border Element, Oracle ACME Session Border Controller, AudioCodes Session Bord…
RouteGroupPatch
object
2 properties 2 required
TrunkPut
object
5 properties 2 required
DialPatternValidate
object
3 properties
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…
ActionOnRouteList
string
ADD - Add a phone number to the Route List. DELETE - Delete a phone number from the Route List.
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…
Repair
object
6 properties
RouteList
object
6 properties 6 required
TranslationPattern
object
6 properties
RouteGroupGet
object
3 properties 3 required
DialPlan
object
5 properties 5 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…
RouteListGet
object
3 properties 2 required
ResponseStatus
object
5 properties 5 required
TranslationPatternGet
object
4 properties 4 required
TrunkTypeWithDeviceType
object
2 properties 2 required
OriginatorType
string
PEOPLE - The originator type object is a person. TRUNK - Connection between Webex Calling and the premises.
DialPatternPut
object
2 properties
TrunkGet
object
21 properties 6 required
TranslationPatternItem
object
6 properties 5 required
TranslationPatternModifyRequest
object
3 properties
CallInterceptDetails
object
3 properties 2 required
DialPlanGet
object
6 properties 6 required
PostResponse
object
1 property 1 required
TestCallRoutingPostResponse
object
18 properties 3 required
DialPlanPost
object
4 properties 3 required
LocationTranslationPatternCreateRequest
object
3 properties 3 required
NumberStatus
string
FeatureAccessCode
object
Details of a feature access code configured for services that are assigned to the authenticated user.
3 properties 2 required
Emergency
object
7 properties 1 required
ResponseId
object
Response object that contains the unique identifier for the created or updated criteria.
1 property
DialPatternValidationStatus
string
ERRORS - In case one or more dial pattern validation failed OK - If all the patterns are validated successfully
Location
object
Location associated with the hot desking member.
2 properties 2 required
HostedAgent
object
8 properties 6 required
DeviceStatus
string
ONLINE - Device is online OFFLINE - Device is offline UNKNOWN - Unknown. Default
DialPattern
object
2 properties
RouteListPatch
object
2 properties
PbxUser
object
9 properties 3 required
OutgoingCallingPlanPermissionsByType
object
6 properties 1 required
Trunk
object
6 properties 2 required
LocalGateways
object
4 properties 2 required
RouteListPost
object
3 properties 3 required
RouteGroupUsageRouteListGet
object
1 property
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…
RouteGroupPost
object
2 properties 2 required
TrunkTypeGetList
object
1 property 1 required
DeviceType
string
DEVICE - The endpoint is a device. APPLICATION - The endpoint is a application.
DialPatternAction
string
ADD - Add action, when adding a new dial pattern DELETE - Delete action, when deleting an existing dial pattern
PstnNumber
object
6 properties
RouteListNumberListGet
object
1 property 1 required
UnknownNumber
object
6 properties
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.
CallingPlanReason
string
FRAUDCONTAINMENT - Calling plan gives the Fraud Containment reason. CISCOCALLINGPLAN - The Cisco calling plan reason. TRANSFERNUMBER1NOTCONFIGURED - The reason…
UnknownExtension
object
6 properties
LocationTranslationPatternModifyRequest
object
3 properties
TrunkFQDNValidatePost
object
3 properties
CallSourceInfo
object
6 properties 1 required
RouteListNumberPatch
object
2 properties 2 required
DialPatternValidateResult
object
2 properties
RouteListNumberPatchResponse
object
3 properties 3 required
RouteListListGet
object
6 properties 4 required
OutgoingCallingPlanPermissionsByDigitPattern
object
7 properties 4 required
RouteGroupUsageRouteListItem
object
4 properties 4 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…
DialPlanPut
object
3 properties 3 required
Organization
object
2 properties 2 required
RouteGroupUsageGetResponse
object
3 properties 3 required
RouteGroup
object
3 properties 3 required
DialPatternStatus
string
INVALID - Invalid pattern DUPLICATE - Duplicate pattern DUPLICATEINLIST - Duplicate in input
LocationTranslationPatternGet
object
4 properties 4 required
LocalGatewayUsageCount
object
4 properties 4 required
ServiceType
string
AUTOATTENDANT - The destination is an auto attendant. BROADWORKSANYWHERE - The destination is the Office (Broadworks) Anywhere feature. CALLQUEUE - The destina…
DialPlanUsageGetResponse
object
2 properties 2 required
VirtualExtension
object
14 properties 4 required
HostedFeature
object
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-call-routing-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Webex Call Routing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.