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 DNC Management API

Operations for managing Do Not Contact (DNC) lists and phone number entries

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

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

This API exposes 3 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

3 operations 2 paths 12 schemas 1 DELETE1 GET1 POST

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 DNC Management 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 3

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

DNC Management 3

Operations for managing Do Not Contact (DNC) lists and phone number entries

POST
/v3/campaign-management/dncList/{dncListName}/phoneNumber
Add Phone Number to DNC List
addPhoneNumberToDncList 1 param body → 201400401403404409429500
GET
/v3/campaign-management/dncList/{dncListName}/phoneNumber/{phoneNumber}
Get Phone Number from DNC List
getPhoneNumberFromDncList 2 params → 200400401403404429500502
DELETE
/v3/campaign-management/dncList/{dncListName}/phoneNumber/{phoneNumber}
Remove Phone Number from DNC List
removePhoneNumberFromDncList 2 params → 204400401403404429500502

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are DncEntryResponse (6 properties), ServiceUnavailableError (4 properties), GatewayTimeoutError (4 properties), BadGatewayError (4 properties). Each schema is shown below with its type and property counts.

ConflictError
object
3 properties 2 required
BadRequestError
object
3 properties 2 required
BadGatewayError
object
4 properties 2 required
InternalServerError
object
3 properties 2 required
TooManyRequestsError
object
3 properties 2 required
NotFoundError
object
3 properties 2 required
DncEntryRequest
object
3 properties 2 required
GatewayTimeoutError
object
4 properties 2 required
ServiceUnavailableError
object
4 properties 2 required
DncEntryResponse
object
6 properties
UnauthorizedError
object
3 properties 2 required
ForbiddenError
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-dnc-management-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