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 Campaign Manager API

The Campaign Manager API from Webex — 2 operation(s) for campaign manager.

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

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

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

3 operations 2 paths 6 schemas 1 DELETE1 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 Campaign Manager 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 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Campaign Manager 3
POST
/v1/dialer/campaign
Start Campaign Request
startCampaignRoute body → 202400401403500503
PUT
/v1/dialer/campaign/{campaignId}
Update Campaign Request
updateCampaignRoute 1 param body → 202400401403500503
DELETE
/v1/dialer/campaign/{campaignId}
Stop Campaign Request
stopCampaignRoute 1 param → 204400401403500503

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are StartCampaignRequest (21 properties), UpdateCampaignRequest (11 properties), CallProgressAnalysisParamsRequest (8 properties), CampaignListResponse (2 properties). Each schema is shown below with its type and property counts.

CampaignURLResponse
object
1 property 1 required
StartCampaignRequest
object
21 properties 8 required
MetaSubInfo
object
1 property
CallProgressAnalysisParamsRequest
object
(Optional) Call Progressive Params details. This is used for Progressive 1:N Dialer.
8 properties
CampaignListResponse
object
2 properties 2 required
UpdateCampaignRequest
object
11 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-campaign-manager-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