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.
Query Parameters
Create the operating mode for this organization.
Body Parameters
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 Monday to Friday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode schedule for Saturday to Sunday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode schedule for different hours daily. Mandatory if type is DIFFERENT_HOURS_DAILY.
Operating mode schedule for Sunday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode schedule for Monday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode schedule for Tuesday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode schedule for Wednesday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode schedule for Thursday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode schedule for Friday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode schedule for Saturday.
Specifies if the operating mode schedule for the specified weekday(s) is enabled, or not. False if the flag is not set.
Specifies if the operating mode is enabled for the entire day. False if the flag is not set.
Start time for the operating mode.
End time for the operating mode.
Operating mode holidays. Mandatory if type is HOLIDAY.
Name of the holiday.
Specifies if the operating mode holiday schedule event is enabled for the entire day. False if the flag is not set.
Start date of the operating mode holiday.
End date of the operating mode holiday.
Start time for the operating mode holiday. Mandatory if allDayEnabled is false.
End time for the operating mode holiday. Mandatory if allDayEnabled is false.
Recurrence configuration for the operating mode holiday.
Recurrence definition yearly by date.
Schedule the event on a specific day of the month.
Schedule the event on a specific month of the year.
Recurrence definition yearly by day.
Schedule the event on a specific day.
Schedule the event on a specific week.
Schedule the event on a specific month.
Call forwarding settings for an operating mode.
Call forwarding is enabled, or disabled. False if the flag is not set.
The destination for forwarding.
The destination voicemail enabled. False if the flag is not set.
Response Properties
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:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
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`.
{
"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
}
}
{
"id": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg"
}