Create Sequential Ring Criteria for a Workspace
Create sequential ring criteria 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. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.
This API requires a full, user or location administrator auth token with the spark-admin:workspaces_write to update 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.
Body Parameters
Name of the location's schedule which determines when the sequential ring is in effect.
This indicates the type of schedule.
Indicates schedule is of type holidays.
Indicates schedule is of type businessHours.
This indicates the level of the schedule specified by scheduleName.
Indicates schedule specified is of GROUP level.
This indicates if criteria are applicable for calls from any phone number or selected phone numbers.
Indicates sequential ring criteria only apply for selected incoming numbers.
Indicates that sequential ring criteria apply for any incoming number.
When true incoming calls from private numbers are allowed. This is only applicable when callsFrom is set to SELECT_PHONE_NUMBERS.
When true incoming calls from unavailable numbers are allowed. This is only applicable when callsFrom is set to SELECT_PHONE_NUMBERS.
When callsFrom is set to SELECT_PHONE_NUMBERS, indicates a list of incoming phone numbers for which the criteria apply.
When set to true sequential ringing is enabled for calls that meet the current criteria. Criteria with ringEnabled set to false take priority.
Response Properties
Unique identifier for the newly created criteria.
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.
Body
- Name of the location's schedule which determines when the sequential ring is in effect.
- This indicates the type of schedule.
- This indicates the level of the schedule specified by `scheduleName`.
- This indicates if criteria are applicable for calls from any phone number or selected phone numbers.
- When `true` incoming calls from private numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`.
- When `true` incoming calls from unavailable numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`.
- When callsFrom is set to `SELECT_PHONE_NUMBERS`, indicates a list of incoming phone numbers for which the criteria apply.
- When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority.
{
"scheduleName": "Business Vacation",
"scheduleType": "holidays",
"scheduleLevel": "GROUP",
"callsFrom": "SELECT_PHONE_NUMBERS",
"anonymousCallersEnabled": true,
"unavailableCallersEnabled": false,
"phoneNumbers": [
"+442071838750",
"+442071839751"
],
"ringEnabled": true
}
{
"id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ"
}