User Call Settings - Retrieve the List of Available Features.

Retrieve the List of Available Features.

Retrieve a list of feature identifiers that can be assigned to a user for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt Groups.

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.

GET/v1/telephony/config/people/{personId}/modeManagement/availableFeatures

URI Parameters

personId

string

A unique identifier for the user.

Query Parameters

name

string

List features whose name contains this string.

phoneNumber

List features whose phoneNumber contains this matching string.

extension

string

List features whose extension contains this matching string.

max

number

Maximum number of features to return in a single page.

start

number

Start at the zero-based offset in the list of matching objects.

order

string

Sort the list of features based on name, phoneNumber, or extension, either asc, or desc.

orgId

string

Retrieve features list from this organization.

Response Properties

features

array[UserModeManagementAvailableFeaturesObject]

Array of features.

string

A unique identifier for the feature.

name

string

Unique name for the feature.

type

ModeManagementFeatureTypeObject

Defines the scheduling of the operating mode.

AUTO_ATTENDANT

string

Specifies the feature is an Auto Attendant.

CALL_QUEUE

string

Specifies the feature is a Call Queue.

HUNT_GROUP

string

Specifies the feature is a Hunt Group.

phoneNumber

string

The primary phone number configured for the feature.

extension

string

The extension configured for the feature.

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.

GET

/v1/telephony/config/people//modeManagement/availableFeatures{?name,phoneNumber,extension,max,start,order,orgId}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

name
string
List features whose `name` contains this string.
phoneNumber
string
List features whose phoneNumber contains this matching string.
extension
string
List features whose `extension` contains this matching string.
max
number
Maximum number of features to return in a single page.
start
number
Start at the zero-based offset in the list of matching objects.
order
string
Sort the list of features based on `name`, `phoneNumber`, or `extension`, either `asc`, or `desc`.
orgId
string
Retrieve features list from this organization.

https://webexapis.com/v1/telephony/config/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI/modeManagement/availableFeatures?name=Day&phoneNumber=+35391884653&extension=1234&start=0&order=name-asc&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
    "features": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ",
            "name": "Test Auto Attendant",
            "type": "AUTO_ATTENDANT",
            "phoneNumber": "+19705550028",
            "extension": "0028"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNWMwZmYzZjctZjY2YS00NGQwLTlhODktZGY5N2U5MThkNjcw",
            "name": "Test Call Queue",
            "type": "CALL_QUEUE",
            "phoneNumber": "2055552221",
            "extension": "0007"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvOTExNmRmZDMtZGQ4ZS00YTk5LTg1MmYtMjFiYmMxOGNkNzcy",
            "name": "Test Hunt Group",
            "type": "HUNT_GROUP",
            "phoneNumber": "2055552221",
            "extension": "0023"
        }
    ]
}