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 Features: Operating Modes API

The Features: Operating Modes API from Webex — 7 operation(s) for features: operating modes.

Webex Features: Operating Modes API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Features: Operating Modes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 7 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

11 operations 7 paths 24 schemas 2 DELETE5 GET2 POST2 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 Features: Operating Modes 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 11

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

Features: Operating Modes 11
GET
/telephony/config/operatingModes
Read the List of Operating Modes
Read the List of Operating Modes 7 params → 200400401403404405409410
GET
/telephony/config/operatingModes/{modeId}
Get Details for an Operating Mode
Get Details for an Operating Mode 2 params → 200400401403404405409410
PUT
/telephony/config/operatingModes/{modeId}
Modify an Operating Mode
Modify an Operating Mode 2 params body → 204400401403404405409410
DELETE
/telephony/config/operatingModes/{modeId}
Delete an Operating Mode
Delete an Operating Mode 2 params → 204400401403404405409410
POST
/telephony/config/operatingModes/
Create an Operating Mode
Create an Operating Mode 1 param body → 201400401403404405409410
GET
/telephony/config/operatingModes/{modeId}/holidays/{holidayId}
Get details for an Operating Mode Holiday
Get details for an Operating Mode Holiday 3 params → 200400401403404405409410
PUT
/telephony/config/operatingModes/{modeId}/holidays/{holidayId}
Modify an Operating Mode Holiday
Modify an Operating Mode Holiday 3 params body → 204400401403404405409410
DELETE
/telephony/config/operatingModes/{modeId}/holidays/{holidayId}
Delete an Operating Mode Holiday
Delete an Operating Mode Holiday 3 params → 204400401403404405409410
POST
/telephony/config/operatingModes/{modeId}/holidays
Create an Operating Mode Holiday
Create an Operating Mode Holiday 2 params body → 201400401403404405409410
GET
/telephony/config/locations/{locationId}/operatingModes/availableOperatingModes
Retrieve the List of Available Operating Modes in a Location
Retrieve the List of Available Operating Modes in a Location 2 params → 200400401403404405409410
GET
/telephony/config/locations/{locationId}/operatingModes/callForwarding/availableNumbers
Get Operating Mode Call Forward Available Phone Numbers
Get Operating Mode Call Forward Available Phone Numbers 7 params → 200400401403404405409410

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are OperatingModeGetObject (9 properties), OperatingModeCallForwardAvailableNumberObject (8 properties), OperatingModeHolidayGetObject (8 properties), OperatingModePostObject (8 properties). Each schema is shown below with its type and property counts.

OperatingModeCallForwarding
object
3 properties 3 required
NumberOwnerType
string
PLACE - PSTN phone number's owner is a workspace. PEOPLE - PSTN phone number's owner is a person. VIRTUALLINE - PSTN phone number's owner is a Virtual Profile.…
OperatingModeCallForwardAvailableNumberListGetObject
object
1 property 1 required
OperatingModeDifferentHoursDailyScheduleObject
object
7 properties 7 required
OperatingModeCallForwardAvailableNumberObject
object
8 properties 5 required
OrgLocLevelObject
string
ORGANIZATION - Specifies this operating mode is configured across the organization. LOCATION - Specifies this operating mode is configured across a location.
OperatingModeHolidayObject
object
7 properties 4 required
LocationObject
object
2 properties 2 required
OperatingModePatchObject
object
5 properties
OperatingModeRecurrenceObject
object
2 properties
OperatingModeScheduleTypeObject
string
SAMEHOURSDAILY - Specifies the operating mode is active during the same hours daily (i.e., same schedule for Monday to Friday, and Saturday to Sunday). DIFFERE…
OperatingModeListGetObject
object
6 properties 5 required
OperatingModeHolidayPatchObject
object
7 properties
OperatingModeDayScheduleObject
object
4 properties 4 required
OperatingModeHolidayGetObject
object
8 properties 5 required
AvailableOperatingModesObject
object
2 properties 2 required
OperatingModeGetObject
object
9 properties 5 required
OperatingModeSameHoursDailyScheduleObject
object
2 properties 2 required
STATE
string
ACTIVE - Phone number is in the active state. INACTIVE - Phone number is in the inactive state.
RecurYearlyByDateObject
object
2 properties 2 required
OperatingModeHolidayPostRequestObject
object
7 properties 4 required
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
RecurYearlyByDayObject
object
3 properties 3 required
OperatingModePostObject
object
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-features-operating-modes-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