Retrieve the List of Features Assigned to a User for Mode Management.
Retrieve a list of feature identifiers that are already assigned to a user for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt Groups.
A maximum of 50 features can be assigned to a user for Mode Management.
Features with mode-based call forwarding enabled can be assigned to a user for Mode Management.
Retrieving this list requires a full, read-only, or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
A unique identifier for the user.
Query Parameters
Retrieve features list from this organization.
Response Properties
Array of assigned features.
A unique identifier for the feature.
Unique name for the feature.
Defines the scheduling of the operating mode.
Specifies the feature is an Auto Attendant.
Specifies the feature is a Call Queue.
Specifies the feature is a Hunt Group.
The primary phone number configured for the feature.
The extension configured for the feature.
A flag to indicate whether mode-based call forwarding is enabled for the feature.
The destination for call forwarding if mode-based call forwarding is enabled.
Name of the current operating mode.
Unique identifier for the current operating mode.
Defines the exception through which the current operating mode is set as active for the feature.
The mode was switched to or extended by the user for manual switch back and runs as an exception until the user manually switches the feature back to normal operation or a different mode.
The mode was switched to by the user before its start time and runs as an exception until its end time is reached, at which point it automatically switches the feature back to normal operation.
The current mode was extended by the user before its end time and runs as an exception until the extension end time (mode's end time + extension of up to 12 hours) is reached, at which point it automatically switches the feature back to normal operation.
The mode will remain the current operating mode for the feature until its normal end time is reached.
Location object that has a unique identifier for the location and its name.
Location identifier associated with the members.
Location name associated with the member.
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
- Retrieve features list from this organization.
{
"features": [
{
"id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ",
"name": "Test Auto Attendant",
"type": "AUTO_ATTENDANT",
"phoneNumber": "+19705550028",
"extension": "0028",
"modeBasedForwardingEnabled": true,
"forwardDestination": "+14259964241",
"currentOperatingModeName": "Day Operating Mode",
"currentOperatingModeId": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzIxM2I1ZTIwLTljMjAtNDUwNi1iYWE3LTE0OGE0NWQyZWY4OQ",
"exceptionType": "AUTOMATIC_SWITCH_BACK_EARLY_START",
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"name": "Banglore"
}
},
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNWMwZmYzZjctZjY2YS00NGQwLTlhODktZGY5N2U5MThkNjcw",
"name": "Test Call Queue",
"type": "CALL_QUEUE",
"phoneNumber": "2055552221",
"extension": "0007",
"modeBasedForwardingEnabled": true,
"forwardDestination": "+19705550028",
"currentOperatingModeName": "Outage Operating Mode",
"currentOperatingModeId": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2VkMjg0NjE1LWY3ZDgtNDNhOC1iOGJmLTVkYmU2ZjMzMTNjZQ",
"exceptionType": "MANUAL_SWITCH_BACK",
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"name": "Banglore"
}
},
{
"id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvOTExNmRmZDMtZGQ4ZS00YTk5LTg1MmYtMjFiYmMxOGNkNzcy",
"name": "Test Hunt Group",
"type": "HUNT_GROUP",
"phoneNumber": "2055552221",
"extension": "0023",
"modeBasedForwardingEnabled": true,
"forwardDestination": "+19705550028",
"currentOperatingModeName": "Day Operating Mode",
"currentOperatingModeId": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzIxM2I1ZTIwLTljMjAtNDUwNi1iYWE3LTE0OGE0NWQyZWY4OQ",
"exceptionType": "MANUAL_SWITCH_BACK",
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"name": "Banglore"
}
}
]
}