Retrieve Selective Forward Criteria for a Workspace
Retrieve Selective Forward Criteria Settings for a Workspace.
With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week.
This API requires a full, read-only or location administrator auth token with a scope of spark-admin:workspaces_read or a user auth token with a scope of spark:workspaces_read to read workspace settings.
NOTE: This API is only available for professional licensed workspaces.
URI Parameters
Unique identifier for the workspace.
Unique identifier for the criteria.
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
Unique identifier for criteria.
Phone number to forward calls to during this schedule.
Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions.
Name of the location's schedule which determines when the selective forward is in effect.
Indicates the schedule type whether businessHours or holidays.
Indicates the schedule type that specifies the business or working hours during the day.
Indicates the schedule type that specifies the day when your organization is not open.
Indicates the schedule level i.e, Group.
Indicates the schedule level that specifies that criteria is of Group level.
Indicates whether to apply the selective forward criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones.
Indicates the schedule applies to any phone number.
Indicates the schedule applies to select phone number defined in the phoneNumbers property.
When true, enables selective forward to calls from anonymous callers.
When true, enables selective forward to calls if the callers are unavailable.
List of phone numbers checked against incoming calls for a match.
Indicates whether the calls, that fit within these parameters, will be forwarded (if forwardEnabled = true) or not (if forwardEnabled = false).
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.
{
"id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"forwardToPhoneNumber": "+1934898988",
"sendToVoicemailEnabled": true,
"scheduleName": "Business Vacation",
"scheduleType": "holidays",
"scheduleLevel": "GROUP",
"callsFrom": "ANY_PHONE_NUMBER",
"anonymousCallersEnabled": true,
"unavailableCallersEnabled": true,
"numbers": [ "+19075552859", "+19186663950" ],
"forwardEnabled": true
}