Retrieve Sequential Ring Settings for a Workspace
Retrieve sequential ring settings for a workspace.
The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.
This API requires a full, read-only or location administrator auth token with a scope of spark-admin:workspaces_read to read workspace settings.
NOTE: This API is only available for professional licensed workspaces.
URI Parameters
Unique identifier for the workspace.
Query Parameters
ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Response Properties
When set to true sequential ring is enabled.
When set to true, the webex calling primary line will ring first.
The number of times the primary line will ring.
When set to true and the primary line is busy, the system redirects calls to the numbers configured for sequential ringing.
When set to true calls are directed to voicemail.
A list of up to five phone numbers to which calls will be directed.
Phone number set as the sequential number.
When set to true the called party is required to press 1 on the keypad to receive the call.
The number of rings to the specified phone number before the call advances to the subsequent number in the sequence or goes to voicemail.
A list of criteria specifying conditions when sequential ringing is in effect.
Unique identifier for criteria.
Name of the location's schedule which determines when the sequential ring is in effect.
Indicates if criteria are applicable for calls from any phone number or specific phone number.
Criteria applies to all incoming numbers.
Criteria applies only for specific incoming numbers.
When set to true sequential ringing is enabled for calls that meet the current criteria. Criteria with ringEnabled set to false take priority.
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
- ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
{
"enabled": true,
"ringBaseLocationFirstEnabled": true,
"baseLocationNumberOfRings": "2",
"continueIfBaseLocationIsBusyEnabled": true,
"callsToVoicemailEnabled": true,
"phoneNumbers": [
{
"phoneNumber": "+442071838750",
"answerConfirmationRequiredEnabled": true,
"numberOfRings": 3
}
],
"criteria": [
{
"id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"scheduleName": "Business Vacation",
"source": "ALL_NUMBERS",
"ringEnabled": true
}
]
}