Create Priority Alert Criteria for a Workspace
Create Priority Alert Criteria Settings for a Workspace.
The priority alert feature enables administrators to configure priority alert settings for a professional workspace. Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.
This API requires a full, user, or location administrator auth token with the spark-admin:workspaces_write scope or a user auth token with a scope of spark: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 priority alert is in effect.
The Schedule type whether businessHours or holidays.
The Schedule type that specifies the business or working hours during the day.
The Schedule type that specifies the day when your organization is not open.
The Schedule level i.e. Group.
Indicates the schedule level that specifies that criteria is of Group level.
Indicates whether to apply priority alert for calls from Any Phone Number or Select Phone Numbers.
The Schedule applies to any phone number.
Indicates the schedule applies to select phone number defined in the phoneNumbers property.
When true, enables calls from anonymous callers. Value for this attribute is required if callsFrom is SELECT_PHONE_NUMBERS.
When true, enables calls even if callers are unavailable. Value for this attribute is required if callsFrom is SELECT_PHONE_NUMBERS.
the list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if callsFrom is SELECT_PHONE_NUMBERS.
When set to true priority alerting criteria is enabled for calls that meet the current criteria. Criteria with notificationEnabled 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 priority alert is in effect.
- The Schedule type whether `businessHours` or `holidays`.
- The Schedule level i.e. Group.
- Indicates whether to apply priority alert for calls from Any Phone Number or Select Phone Numbers.
- When `true`, enables calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
- When `true`, enables calls even if callers are unavailable. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
- the list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
- When set to `true` priority alerting criteria is enabled for calls that meet the current criteria. Criteria with `notificationEnabled` set to `false` take priority.
{
"scheduleName": "Business Vacation YearEnd",
"scheduleType": "Holidays",
"scheduleLevel": "GROUP",
"callsFrom": "SELECT_PHONE_NUMBERS",
"anonymousCallersEnabled": true,
"unavailableCallersEnabled": true,
"phoneNumbers": [ "+19064441748", "+19186663950" ],
"notificationEnabled": false
}
{
"id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ"
}