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

Read the Dial Plan Locations of a Routing Group

List Dial Plan Locations for a specific route group.

Dial Plans allow you to 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.

Retrieving this location list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/premisePstn/routeGroups/{routeGroupId}/usageDialPlan
URI Parameters
routeGroupId
stringrequired

ID of the requested Route group.

Query Parameters
orgId
string

Organization associated with specific route group.

locationName
string

Return the list of locations matching the location name.

max
number

Limit the number of objects returned to this maximum count.

start
number

Start at the zero-based offset in the list of matching objects.

order
string

Order the locations according to designated fields. Available sort orders are asc, and desc.

Response Properties
locations
array[Location]

Array of locations.

id
string

Unique identifier for the location.

name
string

A unique name for the location.

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
GET
/v1/telephony/config/premisePstn/routeGroups//usageDialPlan{?orgId,locationName,max,start,order}
Log in to try the API.
Header
Query Parameters
  • Organization associated with specific route group.
  • Return the list of locations matching the location name.
  • Limit the number of objects returned to this maximum count.
  • Start at the zero-based offset in the list of matching objects.
  • Order the locations according to designated fields. Available sort orders are `asc`, and `desc`.
  • Request
  • Response
https://webexapis.com/v1/telephony/config/premisePstn/routeGroups/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg/usageDialPlan?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&locationName=locationName&max=5&start=0&order=name-asc%7ClocationName-desc
200 / OK
{
  "locations": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
      "name": "locationName"
    }
  ]
}

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.