DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebarSidebar on Mobile
API Reference
BotsButtons and CardsIntegrationsBYODSService AppsService App GuestsService Apps G2GGuest IssuerWidgetsWebex ConnectLogin with WebexInstant ConnectInstant Connect Meeting LinksDeveloper SandboxBeta ProgramSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsCompliance
Webex APIs
Reference
Data Sources
Admin
OverviewAdmin APIsHybrid ServicesAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner Reports/TemplatesPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSettingsSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and AuthorizationMetadata and Samples
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsMetadata and SamplesBackground Images
Reference
Call ControlsCall Routing
POSTTest Call Routing
GETGet Local Gateway Dial Plan Usage for a Trunk
GETGet Locations Using the Local Gateway as PSTN Connection Routing
GETGet Route Groups Using the Local Gateway
GETGet Local Gateway Usage Count
PUTModify Dial Patterns
POSTValidate a Dial Pattern
GETRead the List of Dial Plans
POSTCreate a Dial Plan
GETGet a Dial Plan
PUTModify a Dial Plan
DELETEDelete a Dial Plan
POSTValidate Local Gateway FQDN and Domain for a Trunk
GETRead the List of Trunks
POSTCreate a Trunk
GETGet a Trunk
PUTModify a Trunk
DELETEDelete a Trunk
GETRead the List of Trunk Types
GETRead the List of Routing Groups
POSTCreate Route Group for a Organization
GETRead a Route Group for a Organization
PUTModify a Route Group for a Organization
DELETERemove a Route Group from an Organization
GETRead the Usage of a Routing Group
GETRead the Call to Extension Locations of a Routing Group
GETRead the Dial Plan Locations of a Routing Group
GETRead the PSTN Connection Locations of a Routing Group
GETRead the Route Lists of a Routing Group
GETRead the List of Route Lists
POSTCreate a Route List
DELETEDelete a Route List
GETGet a Route List
PUTModify a Route List
PUTModify Numbers for Route List
GETGet Numbers assigned to a Route List
GETGet Local Gateway Call to On-Premises Extension Usage for a Trunk
POSTCreate a Translation Pattern for an Organization
GETRetrieve the list of Translation Patterns
GETRetrieve a specific Translation Pattern for an Organization
PUTModify a specific Translation Pattern for an Organization
DELETEDelete a specific Translation Pattern
POSTCreate a Translation Pattern for a Location
GETRetrieve a specific Translation Pattern for a Location
PUTModify a specific Translation Pattern for a Location
DELETEDelete a specific Translation Pattern for a Location
Call Settings For MeCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsDevice Call SettingsDevicesEmergency Services SettingsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Operating ModesFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPartner Reports/TemplatesPeopleRecording ReportReportsReports: Detailed Call HistorySend Activation EmailUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for Wholesale
Overview
Guides
Developer's Guide
Reference
Wholesale Billing ReportsWholesale Provisioning
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Reference
Data Sources
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Directory Services
Reference
Domain ManagementIdentity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall Routing
POSTTest Call Routing
GETGet Local Gateway Dial Plan Usage for a Trunk
GETGet Locations Using the Local Gateway as PSTN Connection Routing
GETGet Route Groups Using the Local Gateway
GETGet Local Gateway Usage Count
PUTModify Dial Patterns
POSTValidate a Dial Pattern
GETRead the List of Dial Plans
POSTCreate a Dial Plan
GETGet a Dial Plan
PUTModify a Dial Plan
DELETEDelete a Dial Plan
POSTValidate Local Gateway FQDN and Domain for a Trunk
GETRead the List of Trunks
POSTCreate a Trunk
GETGet a Trunk
PUTModify a Trunk
DELETEDelete a Trunk
GETRead the List of Trunk Types
GETRead the List of Routing Groups
POSTCreate Route Group for a Organization
GETRead a Route Group for a Organization
PUTModify a Route Group for a Organization
DELETERemove a Route Group from an Organization
GETRead the Usage of a Routing Group
GETRead the Call to Extension Locations of a Routing Group
GETRead the Dial Plan Locations of a Routing Group
GETRead the PSTN Connection Locations of a Routing Group
GETRead the Route Lists of a Routing Group
GETRead the List of Route Lists
POSTCreate a Route List
DELETEDelete a Route List
GETGet a Route List
PUTModify a Route List
PUTModify Numbers for Route List
GETGet Numbers assigned to a Route List
GETGet Local Gateway Call to On-Premises Extension Usage for a Trunk
POSTCreate a Translation Pattern for an Organization
GETRetrieve the list of Translation Patterns
GETRetrieve a specific Translation Pattern for an Organization
PUTModify a specific Translation Pattern for an Organization
DELETEDelete a specific Translation Pattern
POSTCreate a Translation Pattern for a Location
GETRetrieve a specific Translation Pattern for a Location
PUTModify a specific Translation Pattern for a Location
DELETEDelete a specific Translation Pattern for a Location
Call Settings For MeCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsData SourcesDevice Call SettingsDevice ConfigurationsDevicesDomain ManagementEmergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Operating ModesFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsIdentity OrganizationIssuesLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPSTNPartner ManagementPartner Reports/TemplatesPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSend Activation EmailSession TypesSettingsSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
Space Meetings Migration
Calling
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationCore ConceptsCalls
Advanced Features
Call SettingsContactsSupplementary ServicesVoicemailBackground Noise Reduction
Kitchen Sink
Meetings
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationJoin a MeetingMigration To Improved MeetingsPasswords & CaptchasUnified Space Meetings
Advanced Features
Advanced ControlsDialing In and OutStreams & EffectsVideo Resolution
Multistream
Multistream Comprehensive GuideMultistream Quickstart
Migrating SDK V2 to V3
iOSAndroidBrowserNode.jsClick to Call
Developer CommunityCertifications

Test Call Routing

Validates that an incoming call can be routed.

Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location. A dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns. Specific dial patterns can be defined as part of your dial plan.

Test call routing requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

POST/v1/telephony/config/actions/testCallRouting/invoke
Query Parameters
orgId
string

Organization in which we are validating a call routing.

Body Parameters
originatorId
stringrequired

This element is used to identify the originating party. It can be a person ID or a trunk ID.

originatorType
OriginatorTyperequired

This element is used to identify if the originatorId is of type PEOPLE or TRUNK.

PEOPLE
string

The originator type object is a person.

TRUNK
string

Connection between Webex Calling and the premises.

originatorNumber
string

Only used when originatorType is TRUNK. The originatorNumber can be a phone number or URI.

destination
stringrequired

This element specifies the called party. It can be any dialable string, for example, an ESN number, E.164 number, hosted user DN, extension, extension with location code, URL, or FAC code.

includeAppliedServices
boolean

This element is used to retrieve if any translation pattern, call intercept, permission by type or permission by digit pattern is present for the called party.

Response Properties
callSourceInfo
CallSourceInfo

Only returned when originatorNumber is specified in the request.

callSourceType
CallSourceType

Type of call source.

ROUTE_LIST
string

Route list is a type of call source.

DIAL_PATTERN
string

Dial pattern is a type of call source.

UNKOWN_EXTENSION
string

The call source extension is unknown.

UNKOWN_NUMBER
string

The call source phone number is unknown.

routeListName
string

Name of a route list. When originatorType is trunk, originatorId is a valid trunk and the trunk belongs to a route group which is assigned to a route list with the name routeListA and also originatorNumber is a number assigned to routeListA, then routeListA is returned here. This element is returned when callSourceType is ROUTE_LIST.

routeListId
string

Unique identifier for the route list.

dialPlanName
string

Name of a dial plan. When originatorType is trunk, originatorId is a valid trunk with the name trunkA, trunkA belongs to a route group which is assigned to a route list with the name routeListA, trunkA is also assigned to dialPlanA as routing choice, dialPlanA has dialPattern xxxx assigned. If the originatorNumber matches the dialPattern xxxx, dialPlanA is returned. This element is returned when callSourceType is DIAL_PATTERN.

dialPattern
string

Pattern given to a dial plan. When originatorType is trunk, originatorId is a valid trunk with the name trunkA, trunkA belongs to a route group which is assigned to a route list with the name routeListA, trunkA is also assigned to dialPlanA as routing choice, dialPlanA has dialPattern xxxx assigned. If the originatorNumber matches the dialPattern xxxx, dialPattern xxxx is returned. This element is returned when callSourceType is DIAL_PATTERN.

dialPlanId
string

Unique identifier for dial plan.

destinationType
CallDestinationType

Destination type for the call.

HOSTED_AGENT
string

A destination is a person or workspace with details in the hostedAgent field.

HOSTED_FEATURE
string

Destination is a calling feature like auto-attendant or hunt group with details in the hostedFeature field.

PBX_USER
string

Destination routes into a separate PBX with details in the pbxUser field.

PSTN_NUMBER
string

Destination routes into a PSTN phone number with details in the pstnNumber field.

VIRTUAL_EXTENSION
string

Destination routes into a virtual extension with details in the virtualExtension field.

VIRTUAL_EXTENSION_RANGE
string

Destination routes into a virtual extension range with details in the virtualExtensionRange field.

ROUTE_LIST
string

Destination routes into a route list with details in the routeList field.

FAC
string

Destination routes into a feature access code (FAC) with details in the featureAccessCode field.

EMERGENCY
string

Destination routes into an emergency service like Red Sky, with details in the emergency field.

REPAIR
string

The route is in a repair state with routing choice details in the repair field.

UNKNOWN_EXTENSION
string

Target extension is unknown with routing choice details in the unknownExtension field.

UNKNOWN_NUMBER
string

The target phone number is unknown with routing choice details in the unknownNumber field.

routingAddress
string

FAC code if destinationType is FAC. The routing address will be returned for all other destination types.

outsideAccessCode
string

Outside access code.

isRejected
boolean

true if the call would be rejected.

hostedAgent
HostedAgent

Returned when destinationType is HOSTED_AGENT.

id
string

Unique identifier for the person or workspace agent identified as call destination.

type
HostedAgentType

Type of agent for call destination.

PEOPLE
string

This object is a person.

PLACE
string

A workspace that is not assigned to a specific person such as for a shared device in a common area.

firstName
string

First name for the hosted agent specified by id.

lastName
string

Last name for the hosted agent specified by id.

locationName
string

Name of hosted agent's location.

locationId
string

Unique identifier for hosted agent's location.

phoneNumber
string

Phone number for the hosted agent.

extension
string

Extension for the hosted agent.

hostedFeature
HostedFeature

Returned when destinationType is HOSTED_FEATURE.

type
ServiceType

Type of the service identified as call destination.

AUTO_ATTENDANT
string

The destination is an auto attendant.

BROADWORKS_ANYWHERE
string

The destination is the Office (Broadworks) Anywhere feature.

CALL_QUEUE
string

The destination is the Call Queue feature.

CONTACT_CENTER_LINK
string

The destination is the Contact Center Link feature.

GROUP_PAGING
string

The destination is the Group Paging feature.

HUNT_GROUP
string

The destination is the Hunt Group feature.

VOICE_MESSAGING
string

The destination is the Voice Messaging feature.

VOICE_MAIL_GROUP
string

The destination is the Voice Mail Group feature.

name
string

Name of the service identified as call destination.

id
string

Unique identifier of the service identified as call destination.

locationName
string

Name of the location with which the service is associated.

locationId
string

Unique identifier for the location of the service.

phoneNumber
string

Phone number of the service.

extension
string

Extension of the service.

pbxUser
PbxUser

Returned when destinationType is PBX_USER.

dialPlanName
string

Dial plan name that the called string matches.

dialPlanId
string

Unique identifier for the dial plan.

dialPattern
string

Dial pattern that the called string matches.

trunkName
string

Name of the trunk.

trunkId
string

Unique identifier of the trunk.

routeGroupName
string

Name of the route group.

routeGroupId
string

Unique identifier of the route group.

trunkLocationName
string

Location of the trunk; required if trunkName is returned.

trunkLocationId
string

Location ID of the trunk; required if trunkName is returned.

pstnNumber
PstnNumber

Returned when destinationType is PSTN_NUMBER.

trunkName
string

Name of the trunk.

trunkId
string

Unique identifier of the trunk.

routeGroupName
string

Name of the route group.

routeGroupId
string

Unique identifier of the route group.

trunkLocationName
string

Location of the trunk; required if trunkName is returned.

trunkLocationId
string

Location ID of the trunk; required if trunkName is returned.

virtualExtension
VirtualExtension

Returned when destinationType is VIRTUAL_EXTENSION.

id
string

Unique identifier for the virtual extension.

firstName
string

First name of the virtual extension.

lastName
string

Last name of the virtual extension.

displayName
string

Full name of the virtual extension.

extension
string

Extension that the virtual extension is associated with.

phoneNumber
string

Phone number that the virtual extension is associated with.

locationName
string

Location name if the virtual extension is at the location level, empty if it is at the customer level.

locationId
string

Location ID if the virtual extension is at the location level, empty if it is at the customer level.

trunkName
string

Name of the trunk.

trunkId
string

Unique identifier of the trunk.

routeGroupName
string

Name of the route group.

routeGroupId
string

Unique identifier of the route group.

trunkLocationName
string

Location of the trunk; required if trunkName is returned.

trunkLocationId
string

Location ID of the trunk; required if trunkName is returned.

virtualExtensionRange
VirtualExtensionRange

Returned when destinationType is VIRTUAL_EXTENSION_RANGE.

id
string

Unique identifier for virtual extension range.

name
string

Name of the virtual extension range.

prefix
string

Prefix that the virtual extension range is associated with (Note: Standard mode must have leading '+' in prefix; BCD/Enhanced mode can have any valid prefix).

pattern
string

Pattern associated with the virtual extension range.

locationName
string

Location name if the virtual extension range is at the location level, empty if it is at the customer level.

locationId
string

Location ID if the virtual extension range is at the location level, empty if it is at customer level.

trunkName
string

Name of the trunk.

trunkId
string

Unique identifier of the trunk.

routeGroupName
string

Name of the route group.

routeGroupId
string

Unique identifier of the route group.

trunkLocationName
string

Location of the trunk; required if trunkName is returned.

trunkLocationId
string

Location ID of the trunk; required if trunkName is returned.

routeList
RouteList

Returned when destinationType is ROUTE_LIST.

id
string

Unique identifier of the route list.

name
string

Name of the route list.

routeGroupName
string

Name of the route group the route list is associated with.

routeGroupId
string

Unique identifier of the route group the route list is associated with.

locationName
string

Location name of the route list.

locationId
string

Location ID of the route list.

featureAccessCode
FeatureAccessCode

Returned when destinationType is FAC.

code
string

Feature access code to which the call is directed.

name
string

Name of the feature associated with code.

emergency
Emergency

Returned when destinationType is EMERGENCY.

isRedSky
boolean

If RedSky is in use.

trunkName
string

Name of the trunk.

trunkId
string

Unique identifier of the trunk.

routeGroupName
string

Name of the route group that is associated with trunk specified by trunkId.

routeGroupId
string

Unique identifier of the route group.

trunkLocationName
string

Location of the trunk; required if trunkName is returned.

trunkLocationId
string

Unique identifier of the location of the trunk; required if trunkName is returned.

repair
Repair

Returned when destinationType is REPAIR.

trunkName
string

Name of the trunk.

trunkId
string

Unique identifier of the trunk.

routeGroupName
string

Name of the route group.

routeGroupId
string

Unique identifier of the route group.

trunkLocationName
string

Location of the trunk; required if trunkName is returned.

trunkLocationId
string

Location ID of the trunk; required if trunkName is returned.

unknownExtension
UnknownExtension

Returned when destinationType is UNKNOWN_EXTENSION.

trunkName
string

Name of the trunk.

trunkId
string

Unique identifier of the trunk.

routeGroupName
string

Name of the route group.

routeGroupId
string

Unique identifier of the route group.

trunkLocationName
string

Location of the trunk; required if trunkName is returned.

trunkLocationId
string

Location ID of the trunk; required if trunkName is returned.

unknownNumber
UnknownNumber

Returned when destinationType is UNKNOWN_NUMBER.

trunkName
string

Name of the trunk.

trunkId
string

Unique identifier of the trunk.

routeGroupName
string

Name of the route group.

routeGroupId
string

Unique identifier of the route group.

trunkLocationName
string

Location of the trunk; required if trunkName is returned.

trunkLocationId
string

Location ID of the trunk; required if trunkName is returned.

appliedServices
array[AppliedServices]

Returned if any origin is configured with intercept details, outgoing permissions by type, or translation pattern.

translationPattern
TranslationPattern

Returns the details of the Translation Pattern if applied.

configurationLevel
enum

The level from which the configuration is applied.

LOCATION
string

The applied services of location level.

ORGANIZATION
string

The applied services of the organization level.

name
string

Name given to a translation pattern.

matchingPattern
string

Matching pattern given to a translation pattern.

replacementPattern
string

Replacement pattern given to a translation pattern.

matchedNumber
string

The original called number.

translatedNumber
string

The modified number after matching against matchingPattern and replacing with corresponding replacementPattern.

interceptDetails
CallInterceptDetails

Returns the details of call intercept if applied.

configurationLevel
ConfigurationLevelType

The level from which the configuration is applied.

LOCATION
string

The applied services at the location level.

PEOPLE
string

The applied services at the people level.

PLACE
string

The applied services at the place level.

VIRTUAL_LINE
string

The applied services at the virtual line level.

permission
enum

The choices that indicate call intercept permissions.

DISALLOW
string

Call intercept is disabled.

TRANSFER
string

Call intercept is transferred to a number.

transferNumber
string

The number to which the outgoing permission by type is to be transferred.

outgoingCallingPlanPermissionsByType
OutgoingCallingPlanPermissionsByType

Returns the details of permissions by type configuration if applied under OCP.

configurationLevel
ConfigurationLevelType

The level from which the configuration is applied.

LOCATION
string

The applied services at the location level.

PEOPLE
string

The applied services at the people level.

PLACE
string

The applied services at the place level.

VIRTUAL_LINE
string

The applied services at the virtual line level.

callType
enum

Designates the action to be taken for each call type and if transferring the call type is allowed.

INTERNAL_CALL
string

Controls calls within your own company.

TOLL_FREE
string

Controls calls to a telephone number that is billed for all arriving calls instead of incurring charges to the originating caller, usually free of charge from a landline.

INTERNATIONAL
string

Controls calls to locations outside of the long-distance areas that require an international calling code before the number is dialed.

OPERATOR_ASSISTED
string

Controls calls requiring Operator Assistance.

CHARGEABLE_DIRECTORY_ASSISTED
string

Controls calls to Directory Assistant companies that require a charge to connect the call.

SPECIAL_SERVICES_I
string

Controls calls to carrier-specific number assignments to special services or destinations.

SPECIAL_SERVICES_II
string

Controls calls to carrier-specific number assignments to special services or destinations.

PREMIUM_SERVICES_I
string

Controls calls used to provide information or entertainment for a fee charged directly to the caller.

PREMIUM_SERVICES_II
string

Controls calls used to provide information or entertainment for a fee charged directly to the caller.

NATIONAL
string

Controls calls that are within your country of origin, both within and outside of your local area code.

permission
CallingPermissionAction

Action to be performed on the input number that matches with the OCP.

ALLOW
string

Allow the designated call type.

BLOCK
string

Block the designated call type.

AUTH_CODE
string

Allow only via Authorization Code.

TRANSFER_NUMBER_1
string

Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.

TRANSFER_NUMBER_2
string

Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.

TRANSFER_NUMBER_3
string

Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.

transferNumber
string

The number to which the outgoing permission by type is to be transferred.

reason
CallingPlanReason

The reason for the result reported for non-standard OCP service.

FRAUD_CONTAINMENT
string

Calling plan gives the Fraud Containment reason.

CISCO_CALLING_PLAN
string

The Cisco calling plan reason.

TRANSFER_NUMBER_1_NOT_CONFIGURED
string

The reason if the transfer number 1 is not configured.

TRANSFER_NUMBER_2_NOT_CONFIGURED
string

The reason if the transfer number 2 is not configured.

TRANSFER_NUMBER_3_NOT_CONFIGURED
string

The reason if the transfer number 3 is not configured.

WEBEX_MOBILE_PREMIUM_INTERNATIONAL_TRANSFER_FORWARD
string

The reason for Webex mobile international transfer forward.

number
string

A transfer number is present in case it gets transferred to some other number.

outgoingCallingPlanPermissionsByDigitPattern
OutgoingCallingPlanPermissionsByDigitPattern

Returns the details of the digit pattern configuration if applied under OCP.

configurationLevel
ConfigurationLevelType

The level from which the configuration is applied.

LOCATION
string

The applied services at the location level.

PEOPLE
string

The applied services at the people level.

PLACE
string

The applied services at the place level.

VIRTUAL_LINE
string

The applied services at the virtual line level.

name
string

Name given to a digit pattern.

permission
CallingPermissionAction

Action to be performed on the input number that matches with the digit pattern.

ALLOW
string

Allow the designated call type.

BLOCK
string

Block the designated call type.

AUTH_CODE
string

Allow only via Authorization Code.

TRANSFER_NUMBER_1
string

Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.

TRANSFER_NUMBER_2
string

Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.

TRANSFER_NUMBER_3
string

Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.

transferNumber
string
pattern
string

Pattern for the digit pattern.

reason
CallingPlanReason

The reason for the result reported for a non-standard OCP service.

FRAUD_CONTAINMENT
string

Calling plan gives the Fraud Containment reason.

CISCO_CALLING_PLAN
string

The Cisco calling plan reason.

TRANSFER_NUMBER_1_NOT_CONFIGURED
string

The reason if the transfer number 1 is not configured.

TRANSFER_NUMBER_2_NOT_CONFIGURED
string

The reason if the transfer number 2 is not configured.

TRANSFER_NUMBER_3_NOT_CONFIGURED
string

The reason if the transfer number 3 is not configured.

WEBEX_MOBILE_PREMIUM_INTERNATIONAL_TRANSFER_FORWARD
string

The reason for Webex mobile international transfer forward.

number
string

A transfer number is present in case of a transfer to another number.

Response Codes

The list below describes the common success and error responses you should expect from the API:

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
POST
/v1/telephony/config/actions/testCallRouting/invoke{?orgId}
Log in to try the API.
Header
Query Parameters
  • Organization in which we are validating a call routing.
Body
  • This element is used to identify the originating party. It can be a person ID or a trunk ID.
  • This element is used to identify if the `originatorId` is of type `PEOPLE` or `TRUNK`.
  • Only used when `originatorType` is `TRUNK`. The `originatorNumber` can be a phone number or URI.
  • This element specifies the called party. It can be any dialable string, for example, an ESN number, E.164 number, hosted user DN, extension, extension with location code, URL, or FAC code.
  • This element is used to retrieve if any translation pattern, call intercept, permission by type or permission by digit pattern is present for the called party.
  • Request
  • Response
https://webexapis.com/v1/telephony/config/actions/testCallRouting/invoke?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
    "originatorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
    "originatorType": "PEOPLE",
    "destination": "0007",
    "includeAppliedServices": true
}
200 / OK
{
    "callSourceInfo": {
        "callSourceType": "DIAL_PATTERN",
        "routeListName": "routeList1",
        "routeListId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvZDA2YWQ5M2QtY2NkOC00MzI1LTg0YzUtMDA2NThhYTdhMDBj",
        "dialPlanName": "dialPlan1",
        "dialPattern": "*888",
        "dialPlanId": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI"
    },
    "destinationType": "HOSTED_AGENT",
    "routingAddress": "007",
    "outsideAccessCode": "1234",
    "isRejected": false,
    "hostedAgent": {
        "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMjU4YjhmZi1lODIxLTQ3MDktYTI2My1mMmI4OWZjN2FlYmQ",
        "type": "PEOPLE",
        "firstName": "firstName",
        "lastName": "lastName",
        "locationName": "locationName",
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
        "phoneNumber": "9874531287",
        "extension": "111"
    },
    "hostedFeature": {
        "type": "AUTO_ATTENDANT",
        "name": "name1",
        "id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QyRXdhV2R5TVRCamIwQTJORGswTVRJNU55NXBiblF4TUM1aVkyeGtMbmRsWW1WNExtTnZiUT09",
        "locationName": "locationName1",
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
        "phoneNumber": "9874531287",
        "extension": "111"
    },
    "pbxUser": {
        "dialPlanName": "dialPlan1",
        "dialPlanId": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
        "dialPattern": "442xxx",
        "trunkName": "trunkName1",
        "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "trunkLocationName": "trunkLocationName1",
        "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "pstnNumber": {
        "trunkName": "trunkName1",
        "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "trunkLocationName": "trunkLocationName1",
        "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "virtualExtension": {
        "id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OL2U4NTU0MGJjLWFiNDMtNGZjOS05ZThlLTkxZjRkN2E3ZjU5Ng",
        "firstName": "firstName1",
        "lastName": "lastName1",
        "displayName": "displayName1",
        "extension": "0007",
        "phoneNumber": "8701278963",
        "locationName": "locationName1",
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
        "trunkName": "trunkName1",
        "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "trunkLocationName": "trunkLocationName1",
        "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "virtualExtensionRange": {
        "id": "OTI0NzM1OTQtZGU1Mi00ZjViLTk0YjItN2Y5MzRmY2Y2NDk3",
        "name": "firstName1",
        "prefix": "+1214555",
        "pattern": "2XXX",
        "locationName": "locationName1",
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
        "trunkName": "trunkName1",
        "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "trunkLocationName": "trunkLocationName1",
        "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "routeList": {
        "id": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvZDA2YWQ5M2QtY2NkOC00MzI1LTg0YzUtMDA2NThhYTdhMDBj",
        "name": "routeListName1",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "locationName": "locationName1",
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "featureAccessCode": {
        "code": "*70",
        "name": "Cancel Call Waiting"
    },
    "emergency": {
        "isRedSky": true,
        "trunkName": "trunkName1",
        "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "trunkLocationName": "trunkLocationName1",
        "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "repair": {
        "trunkName": "trunkName1",
        "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "trunkLocationName": "trunkLocationName1",
        "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "unknownExtension": {
        "trunkName": "trunkName1",
        "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "trunkLocationName": "trunkLocationName1",
        "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "unknownNumber": {
        "trunkName": "trunkName1",
        "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
        "routeGroupName": "routeGroupName1",
        "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
        "trunkLocationName": "trunkLocationName1",
        "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
    },
    "appliedServices": [
        {
        "translationPattern": {
            "configurationLevel": "ORGANIZATION",
            "name": "TP1",
            "matchingPattern": "+91XXX",
            "replacementPattern": "+91234",
            "matchedNumber": "+91236",
            "translatedNumber": "+91234"
        },
        "interceptDetails": {
            "configurationLevel": "USER",
            "permission": "TRANSFER",
            "transferNumber": "+14157279300"
        },
        "outgoingCallingPlanPermissionsByType": {
            "configurationLevel": "PEOPLE",
            "callType": "INTERNAL_CALL",
            "permission": "ALLOW",
            "transferNumber": "+14157279300",
            "reason": "FRAUD_CONTAINMENT",
            "number": "+14157279300"
        },
        "outgoingCallingPlanPermissionsByDigitPattern": {
            "configurationLevel": "USER",
            "name": "DPattern",
            "permission": "ALLOW",
            "transferNumber": "+14157279300",
            "pattern": "+91!",
            "reason": "FRAUD_CONTAINMENT",
            "number": "+14157279300"
        }
        }
    ]
}

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2025 Cisco and/or its affiliates. All rights reserved.