Update a Call Queue Forced Forward service
Update the designated Forced Forward Service.
If the option is enabled, then incoming calls to the queue are forwarded to the configured destination. Calls that are already in the queue remain queued. The policy can be configured to play an announcement prior to proceeding with the forward.
Updating a call queue Forced Forward service requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Location in which this call queue exists.
Update setting for the call queue with the matching ID.
Query Parameters
Update call queue settings from this organization.
Body Parameters
Enable or disable call forced forward service routing policy.
Call gets transferred to this number when action is set to TRANSFER. This can also be an extension.
Indicates whether an announcement plays to callers before the action is applied.
The type of announcement to be played.
Default Audio Message Selection.
Custom Audio Message Selection.
List of pre-configured Announcement Audio Files when audioMessageSelection is CUSTOM.
A unique identifier for the announcement. name, mediaFileType, level are mandatory if id is not provided for uploading an announcement.
Audio announcement file name.
Audio announcement file type.
WAV File Extension.
WMA File Extension.
3GP File Extension.
Audio announcement file type location.
Audio file is configured across organisation.
Audio file is configured across location.
Audio file is configured on instance level.
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
- Update call queue settings from this organization.
Body
- Enable or disable call forced forward service routing policy.
- Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension.
- Indicates whether an announcement plays to callers before the action is applied.
- The type of announcement to be played.
- List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`.
{
"forcedForwardEnabled": true,
"transferPhoneNumber": "+911235557890",
"playAnnouncementBeforeEnabled": true,
"audioMessageSelection": "<DEFAULT | CUSTOM>",
"audioFiles": [
{
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
"fileName": "AUDIO_FILE.wav",
"mediaFileType": "WAV",
"level": "ORGANIZATION"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc",
"fileName": "AUDIO_FILE_1.wav",
"mediaFileType": "WAV",
"level": "LOCATION"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY",
"fileName": "AUDIO_FILE_3.wav",
"mediaFileType": "WAV",
"level": "ORGANIZATION"
}]
}