Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Dial Plan API

The Dial Plan API from Webex — 6 operation(s) for dial plan.

Webex Dial Plan API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dial Plan. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 6 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

9 operations 6 paths 14 schemas 1 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Webex Dial Plan API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Dial Plan 9
GET
/organization/{orgid}/dial-plan
List Dial Plan(s)
getAllConfig_8 5 params → 200401403404429500
POST
/organization/{orgid}/dial-plan
Create a new Dial Plan
createConfig_15 1 param body → 200400401403409429500
POST
/organization/{orgid}/dial-plan/bulk
Bulk save Dial Plan(s)
saveAllConfig_13 1 param body → 207400401403409429500
GET
/organization/{orgid}/dial-plan/bulk-exportdeprecated
Bulk export Dial Plan(s)
bulkExport_13 3 params → 200401403404429500
GET
/organization/{orgid}/dial-plan/{id}
Get specific Dial Plan by ID
getConfig_16 2 params → 200401403404429500
PUT
/organization/{orgid}/dial-plan/{id}
Update specific Dial Plan by ID
updateConfig_16 2 params body → 200400401403404412429500
DELETE
/organization/{orgid}/dial-plan/{id}
Delete specific Dial Plan by ID
deleteConfig_15 2 params → 200401403404412429500
GET
/organization/{orgid}/dial-plan/{id}/incoming-references
List references for a specific Dial Plan
getIncomingReferences_12 5 params → 200401403404429500
GET
/organization/{orgid}/v2/dial-plan
List Dial Plan(s)
getAllConfigWithMetaData_16 6 params → 200401403404429500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are DialPlanDTO (12 properties), MetaDataReferencesPagingInfo (8 properties), EntityInfo (6 properties), BulkExportDTODialPlanBulkExportDTO (5 properties). Each schema is shown below with its type and property counts.

DialPlanDTO
object
12 properties 3 required
ApiErrorResponse
object
Response body for an API error.
2 properties
BulkExportDTODialPlanBulkExportDTO
object
5 properties
ErrorDetails
object
Details of an error.
2 properties
BulkResponseItemDTO
object
5 properties
BulkRequestItemDTODialPlanDTO
object
3 properties
OperationError
object
An error message providing details about the operation failure.
1 property
BulkResponseDTO
object
1 property
ResponseEnvelopeDialPlanDTO
object
2 properties
DialPlanBulkExportDTO
object
4 properties
MetaDataReferencesPagingInfo
object
Metadata of response for references with paging information
8 properties
EntityInfo
object
6 properties
BulkRequestDTODialPlanDTO
object
1 property
EntityReferenceInfoDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-dial-plan-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