Read the List of Operating Modes.
Retrieve Operating Modes list defined at location, or organization level. Use query parameters to filter the result set by location or level. The list returned is sorted in ascending order by operating mode name. Long result sets are split into pages.
Operating modes help manage calls more efficiently by routing them based on predefined settings.
Retrieving this list requires a full, read-only, or location administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
List operating modes whose name contains this string.
Location query parameter to filter the operating modes from that location only.
If true, only return operating modes defined at the organization level.
Maximum number of operating modes to return in a single page. max must be equal to, or greater than 1, and equal to or less than 100.
Start at the zero-based offset in the list of matching objects.
Sort the list of operating modes based on name, either asc, or desc.
Retrieve operating modes list from this organization.
Response Properties
Array of operating modes.
A unique identifier for the operating mode.
Unique name for the operating mode.
Defines the scheduling of the operating mode.
Specifies the operating mode is active during the same hours daily (i.e., same schedule for Monday to Friday, and Saturday to Sunday).
Specifies the operating mode is active during different hours for different days of the week.
Specifies the operating mode is active during holidays with their own days, and recurrence.
Specifies the operating mode doesn't have any schedules defined.
Level at which the operating mode would be defined.
Specifies this operating mode is configured across the organization.
Specifies this operating mode is configured across a location.
Location object having a unique identifier for the location, and its name. Mandatory if level is LOCATION.
Unique identifier of the location.
Name of the location.
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 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
- List `operating modes` whose name contains this string.
- Location query parameter to filter the `operating modes` from that location only.
- If true, only return `operating modes` defined at the organization level.
- Maximum number of `operating modes` to return in a single page. `max` must be equal to, or greater than `1`, and equal to or less than `100`.
- Start at the zero-based offset in the list of matching objects.
- Sort the list of `operating modes` based on `name`, either asc, or desc.
- Retrieve `operating modes` list from this organization.
{
"operatingModes": [
{
"id": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"name": "Day Operating Mode",
"type": "SAME_HOURS_DAILY",
"level": "LOCATION",
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"name": "Cisco-HQ"
},
"callForwarding": {
"enabled": true,
"destination": "+19705550006",
"destinationVoicemailEnabled": false
}
},
{
"id": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzcxYzNjYjA2LWE5YjMtNDc1MS1hZGI1LTdiZDc2MWY5MTAwYg",
"name": "Outage Operating Mode",
"type": "NONE",
"level": "ORGANIZATION",
"callForwarding": {
"enabled": true,
"destination": "+19705550007",
"destinationVoicemailEnabled": true
}
}
]
}