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
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService 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 APIsAuthentication
Guides
Hybrid ServicesWebhooksService Apps G2GReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner 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
Calling 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: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPeopleRecording ReportReportsReports: Detailed Call HistoryUser 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
Identity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksService Apps G2GWebinar 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 AuthorizationWebhooksService Apps G2GButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
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
Calling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsData SourcesDevice Call SettingsDevice ConfigurationsDevicesEmergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsIdentity OrganizationLicensesLocation 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 TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSession 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
iOSAndroidBrowser
Developer CommunityCertifications

Call Routing

Features: Call Routing supports reading and writing of Webex Calling On-premises, also known as Local Gateway, Call Routing PSTN settings for a specific organization.

Viewing these read-only organization settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Modifying these organization settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

A partner administrator can retrieve or change settings in a customer's organization using the optional orgId query parameter.

Method
Description
POSThttps://webexapis.com/v1/telephony/config/actions/testCallRouting/invoke
Test Call Routing
https://webexapis.com/v1/telephony/config/actions/testCallRouting/invoke
POSTTest Call Routing
GEThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usageDialPlan
Get Local Gateway Dial Plan Usage for a Trunk
https://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usageDialPlan
GETGet Local Gateway Dial Plan Usage for a Trunk
GEThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usagePstnConnection
Get Locations Using the Local Gateway as PSTN Connection Routing
https://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usagePstnConnection
GETGet Locations Using the Local Gateway as PSTN Connection Routing
GEThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usageRouteGroup
Get Route Groups Using the Local Gateway
https://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usageRouteGroup
GETGet Route Groups Using the Local Gateway
GEThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usage
Get Local Gateway Usage Count
https://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usage
GETGet Local Gateway Usage Count
PUThttps://webexapis.com/v1/telephony/config/premisePstn/dialPlans/{dialPlanId}/dialPatterns
Modify Dial Patterns
https://webexapis.com/v1/telephony/config/premisePstn/dialPlans/{dialPlanId}/dialPatterns
PUTModify Dial Patterns
POSThttps://webexapis.com/v1/telephony/config/premisePstn/actions/validateDialPatterns/invoke
Validate a Dial Pattern
https://webexapis.com/v1/telephony/config/premisePstn/actions/validateDialPatterns/invoke
POSTValidate a Dial Pattern
GEThttps://webexapis.com/v1/telephony/config/premisePstn/dialPlans
Read the List of Dial Plans
https://webexapis.com/v1/telephony/config/premisePstn/dialPlans
GETRead the List of Dial Plans
POSThttps://webexapis.com/v1/telephony/config/premisePstn/dialPlans
Create a Dial Plan
https://webexapis.com/v1/telephony/config/premisePstn/dialPlans
POSTCreate a Dial Plan
GEThttps://webexapis.com/v1/telephony/config/premisePstn/dialPlans/{dialPlanId}
Get a Dial Plan
https://webexapis.com/v1/telephony/config/premisePstn/dialPlans/{dialPlanId}
GETGet a Dial Plan
PUThttps://webexapis.com/v1/telephony/config/premisePstn/dialPlans/{dialPlanId}
Modify a Dial Plan
https://webexapis.com/v1/telephony/config/premisePstn/dialPlans/{dialPlanId}
PUTModify a Dial Plan
DELETEhttps://webexapis.com/v1/telephony/config/premisePstn/dialPlans/{dialPlanId}
Delete a Dial Plan
https://webexapis.com/v1/telephony/config/premisePstn/dialPlans/{dialPlanId}
DELETEDelete a Dial Plan
POSThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/actions/fqdnValidation/invoke
Validate Local Gateway FQDN and Domain for a Trunk
https://webexapis.com/v1/telephony/config/premisePstn/trunks/actions/fqdnValidation/invoke
POSTValidate Local Gateway FQDN and Domain for a Trunk
GEThttps://webexapis.com/v1/telephony/config/premisePstn/trunks
Read the List of Trunks
https://webexapis.com/v1/telephony/config/premisePstn/trunks
GETRead the List of Trunks
POSThttps://webexapis.com/v1/telephony/config/premisePstn/trunks
Create a Trunk
https://webexapis.com/v1/telephony/config/premisePstn/trunks
POSTCreate a Trunk
GEThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}
Get a Trunk
https://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}
GETGet a Trunk
PUThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}
Modify a Trunk
https://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}
PUTModify a Trunk
DELETEhttps://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}
Delete a Trunk
https://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}
DELETEDelete a Trunk
GEThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/trunkTypes
Read the List of Trunk Types
https://webexapis.com/v1/telephony/config/premisePstn/trunks/trunkTypes
GETRead the List of Trunk Types
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups
Read the List of Routing Groups
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups
GETRead the List of Routing Groups
POSThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups
Create Route Group for a Organization
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups
POSTCreate Route Group for a Organization
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}
Read a Route Group for a Organization
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}
GETRead a Route Group for a Organization
PUThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}
Modify a Route Group for a Organization
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}
PUTModify a Route Group for a Organization
DELETEhttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}
Remove a Route Group from an Organization
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}
DELETERemove a Route Group from an Organization
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usage
Read the Usage of a Routing Group
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usage
GETRead the Usage of a Routing Group
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageCallToExtension
Read the Call to Extension Locations of a Routing Group
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageCallToExtension
GETRead the Call to Extension Locations of a Routing Group
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageDialPlan
Read the Dial Plan Locations of a Routing Group
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageDialPlan
GETRead the Dial Plan Locations of a Routing Group
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usagePstnConnection
Read the PSTN Connection Locations of a Routing Group
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usagePstnConnection
GETRead the PSTN Connection Locations of a Routing Group
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageRouteList
Read the Route Lists of a Routing Group
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageRouteList
GETRead the Route Lists of a Routing Group
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeLists
Read the List of Route Lists
https://webexapis.com/v1/telephony/config/premisePstn/routeLists
GETRead the List of Route Lists
POSThttps://webexapis.com/v1/telephony/config/premisePstn/routeLists
Create a Route List
https://webexapis.com/v1/telephony/config/premisePstn/routeLists
POSTCreate a Route List
DELETEhttps://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}
Delete a Route List
https://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}
DELETEDelete a Route List
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}
Get a Route List
https://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}
GETGet a Route List
PUThttps://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}
Modify a Route List
https://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}
PUTModify a Route List
PUThttps://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}/numbers
Modify Numbers for Route List
https://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}/numbers
PUTModify Numbers for Route List
GEThttps://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}/numbers
Get Numbers assigned to a Route List
https://webexapis.com/v1/telephony/config/premisePstn/routeLists/{routeListId}/numbers
GETGet Numbers assigned to a Route List
GEThttps://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usageCallToExtension
Get Local Gateway Call to On-Premises Extension Usage for a Trunk
https://webexapis.com/v1/telephony/config/premisePstn/trunks/{trunkId}/usageCallToExtension
GETGet Local Gateway Call to On-Premises Extension Usage for a Trunk
POSThttps://webexapis.com/v1/telephony/config/callRouting/translationPatterns
Create a Translation Pattern for an Organization
https://webexapis.com/v1/telephony/config/callRouting/translationPatterns
POSTCreate a Translation Pattern for an Organization
GEThttps://webexapis.com/v1/telephony/config/callRouting/translationPatterns
Retrieve the list of Translation Patterns
https://webexapis.com/v1/telephony/config/callRouting/translationPatterns
GETRetrieve the list of Translation Patterns
GEThttps://webexapis.com/v1/telephony/config/callRouting/translationPatterns/{translationId}
Retrieve a specific Translation Pattern for an Organization
https://webexapis.com/v1/telephony/config/callRouting/translationPatterns/{translationId}
GETRetrieve a specific Translation Pattern for an Organization
PUThttps://webexapis.com/v1/telephony/config/callRouting/translationPatterns/{translationId}
Modify a specific Translation Pattern for an Organization
https://webexapis.com/v1/telephony/config/callRouting/translationPatterns/{translationId}
PUTModify a specific Translation Pattern for an Organization
DELETEhttps://webexapis.com/v1/telephony/config/callRouting/translationPatterns/{translationId}
Delete a specific Translation Pattern
https://webexapis.com/v1/telephony/config/callRouting/translationPatterns/{translationId}
DELETEDelete a specific Translation Pattern
POSThttps://webexapis.com/v1/telephony/config/locations/{locationId}/callRouting/translationPatterns
Create a Translation Pattern for a Location
https://webexapis.com/v1/telephony/config/locations/{locationId}/callRouting/translationPatterns
POSTCreate a Translation Pattern for a Location
GEThttps://webexapis.com/v1/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Retrieve a specific Translation Pattern for a Location
https://webexapis.com/v1/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
GETRetrieve a specific Translation Pattern for a Location
PUThttps://webexapis.com/v1/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Modify a specific Translation Pattern for a Location
https://webexapis.com/v1/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
PUTModify a specific Translation Pattern for a Location
DELETEhttps://webexapis.com/v1/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
Delete a specific Translation Pattern for a Location
https://webexapis.com/v1/telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
DELETEDelete a specific Translation Pattern for a Location

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

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