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 RoutingCall 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 Modes
GETGet Operating Mode Call Forward Available Phone Numbers
Features: 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
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCall 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 Modes
GETGet Operating Mode Call Forward Available Phone Numbers
Features: 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

Create an Operating Mode.

Create an Operating Mode at an organization, or a location level.

Operating modes can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.

Creating an Operating Mode requires a full, or location administrator auth token with a scope of spark-admin:telephony_config_write.

POST/v1/telephony/config/operatingModes/
Query Parameters
orgId
string

Create the operating mode for this organization.

Body Parameters
name
stringrequired

Unique name for the operating mode.

type
OperatingModeScheduleTypeObjectrequired

Defines the scheduling of the operating mode.

Possible values: SAME_HOURS_DAILY
level
OrgLocLevelObjectrequired

Level at which the operating mode would be defined.

Possible values: LOCATION
locationId
string

Unique identifier of the location. Mandatory if level is LOCATION.

sameHoursDaily
OperatingModeSameHoursDailyScheduleObject

Operating mode schedule for same hours daily. Mandatory if type is SAME_HOURS_DAILY.

mondayToFriday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Monday to Friday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

saturdayToSunday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Saturday to Sunday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

differentHoursDaily
OperatingModeDifferentHoursDailyScheduleObject

Operating mode schedule for different hours daily. Mandatory if type is DIFFERENT_HOURS_DAILY.

sunday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Sunday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

monday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Monday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

tuesday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Tuesday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

wednesday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Wednesday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

thursday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Thursday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

friday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Friday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

saturday
OperatingModeDayScheduleObjectrequired

Operating mode schedule for Saturday.

enabled
booleanrequired

Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.

allDayEnabled
booleanrequired

Specifies if the operating mode is enabled for the entire day. False if the flag is not set.

startTime
stringrequired

Start time for the operating mode.

endTime
stringrequired

End time for the operating mode.

holidays
array[OperatingModeHolidayObject]

Operating mode holidays. Mandatory if type is HOLIDAY.

name
stringrequired

Name of the holiday.

allDayEnabled
booleanrequired

Specifies if the operating mode holiday schedule event is enabled for the entire day. False if the flag is not set.

startDate
stringrequired

Start date of the operating mode holiday.

endDate
stringrequired

End date of the operating mode holiday.

startTime
string

Start time for the operating mode holiday. Mandatory if allDayEnabled is false.

endTime
string

End time for the operating mode holiday. Mandatory if allDayEnabled is false.

recurrence
OperatingModeRecurrenceObject

Recurrence configuration for the operating mode holiday.

recurYearlyByDate
object

Recurrence definition yearly by date.

dayOfMonth
numberrequired

Schedule the event on a specific day of the month.

month
enumrequired

Schedule the event on a specific month of the year.

`JANUARY`: Schedule the event in January.
string
`FEBRUARY`: Schedule the event in February.
string
`MARCH`: Schedule the event in March.
string
`APRIL`: Schedule the event in April.
string
`MAY`: Schedule the event in May.
string
`JUNE`: Schedule the event in June.
string
`JULY`: Schedule the event in July.
string
`AUGUST`: Schedule the event in August.
string
`SEPTEMBER`: Schedule the event in September.
string
`OCTOBER`: Schedule the event in October.
string
`NOVEMBER`: Schedule the event in November.
string
`DECEMBER`: Schedule the event in December.
string
recurYearlyByDay
object

Recurrence definition yearly by day.

day
enumrequired

Schedule the event on a specific day.

`SUNDAY`: Schedule the event on Sunday.
string
`MONDAY`: Schedule the event on Monday.
string
`TUESDAY`: Schedule the event on Tuesday.
string
`WEDNESDAY`: Schedule the event on Wednesday.
string
`THURSDAY`: Schedule the event on Thursday.
string
`FRIDAY`: Schedule the event on Friday.
string
`SATURDAY`: Schedule the event on Saturday.
string
week
enumrequired

Schedule the event on a specific week.

`FIRST`: Schedule the event on the first week of the month.
string
`SECOND`: Schedule the event on the second week of the month.
string
`THIRD`: Schedule the event on the third week of the month.
string
`FOURTH`: Schedule the event on the fourth week of the month.
string
`LAST`: Schedule the event on the last week of the month.
string
month
enumrequired

Schedule the event on a specific month.

`JANUARY`: Schedule the event in January.
string
`FEBRUARY`: Schedule the event in February.
string
`MARCH`: Schedule the event in March.
string
`APRIL`: Schedule the event in April.
string
`MAY`: Schedule the event in May.
string
`JUNE`: Schedule the event in June.
string
`JULY`: Schedule the event in July.
string
`AUGUST`: Schedule the event in August.
string
`SEPTEMBER`: Schedule the event in September.
string
`OCTOBER`: Schedule the event in October.
string
`NOVEMBER`: Schedule the event in November.
string
`DECEMBER`: Schedule the event in December.
string
callForwarding
OperatingModeCallForwardingrequired

Call forwarding settings for an operating mode.

enabled
booleanrequired

Call forwarding is enabled, or disabled. False if the flag is not set.

destination
stringrequired

The destination for forwarding.

destinationVoicemailEnabled
booleanrequired

The destination voicemail enabled. False if the flag is not set.

Response Properties
id
string

ID of the newly created operating mode.

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
POST
/v1/telephony/config/operatingModes/{?orgId}
Log in to try the API.
Header
Query Parameters
  • Create the `operating mode` for this organization.
Body
  • Unique name for the `operating mode`.
  • Defines the scheduling of the `operating mode`.
  • Level at which the `operating mode` would be defined.
  • Unique identifier of the location. Mandatory if level is `LOCATION`.
  • `Operating mode` schedule for same hours daily. Mandatory if type is `SAME_HOURS_DAILY`.
  • `Operating mode` schedule for different hours daily. Mandatory if type is `DIFFERENT_HOURS_DAILY`.
  • `Operating mode` holidays. Mandatory if type is `HOLIDAY`.
  • Call forwarding settings for an `operating mode`.
  • Request
  • Response
https://webexapis.com/v1/telephony/config/operatingModes/?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
    "name": "Day Operating Mode",
    "type": "SAME_HOURS_DAILY",
    "level": "LOCATION",
    "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
    "sameHoursDaily": {
        "mondayToFriday": {
            "enabled": true,
            "allDayEnabled": false,
            "startTime": "09:00",
            "endTime": "17:00"
        },
        "saturdayToSunday": {
            "enabled": true,
            "allDayEnabled": true
        }
    },
    "callForwarding": {
        "enabled": true,
        "destination": "+19705550006",
        "destinationVoicemailEnabled": false
    }
}
201 / Created
{
    "id": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg"
}

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.