Update Call Forwarding Settings for a Hunt Group
Update Call Forwarding settings for the specified Hunt Group.
The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define. Below are the available options for configuring your call forwarding:
- Always forward calls to a designated number.
- Forward calls to a designated number based on certain criteria.
- Forward calls using different modes.
Updating call forwarding settings for a hunt group requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Location from which this hunt group exists.
Update call forwarding settings for this hunt group.
Query Parameters
Update hunt group forwarding settings from this organization.
Body Parameters
Settings related to Always, Busy, and No Answer call forwarding.
Settings for forwarding all incoming calls to the destination you choose.
Always call forwarding is enabled or disabled.
Destination for Always call forwarding.
If true, a brief tone will be played on the person's phone when a call has been forwarded.
Sending incoming calls to voicemail is enabled/disabled when the destination is an internal phone number and that number has the voicemail service enabled.
Selectively forward calls to a designated number, depending on criteria rules. You'll need to have at least one rule for forwarding applied for call forwarding to be active.
Busy call forwarding is enabled or disabled.
Destination for Busy call forwarding.
If true, a brief tone will be played on the person's phone when a call has been forwarded.
Sending incoming calls to voicemail is enabled/disabled when the destination is an internal phone number and that number has the voicemail service enabled.
Rules for selectively forwarding calls.
Unique ID for the rule.
Reflects if rule is enabled.
Configuration for forwarding via Operating modes (Schedule Based Routing).
Normal operation is enabled or disabled.
The ID of the operating mode.
Forward to settings.
The selection for forwarding.
When the rule matches, forward to the destination for the hunt group.
When the rule matches, forward to the destination for this rule.
When the rule matches, do not forward to another number.
The destination for forwarding. Required when the selection is set to FORWARD_TO_SPECIFIED_NUMBER.
Sending incoming calls to voicemail is enabled/disabled when the destination is an internal phone number and that number has the voicemail service enabled.
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 hunt group forwarding settings from this organization.
Body
- Settings related to `Always`, `Busy`, and `No Answer` call forwarding.
{
"callForwarding":
{
"always": {
"enabled": false,
"destination": ""},
"selective": {
"enabled": true,
"destination": "35556",
"destinationVoicemailEnabled": true},
"rules": [
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlpVW1WdVlXMWw",
"enabled": true},
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WMmhsYmxSdg",
"enabled": false
}
],
"modes":[
{
"normalOperationEnabled": true,
"id": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"forwardTo":
{
"selection": "FORWARD_TO_SPECIFIED_NUMBER",
"destination": "00000",
"destinationVoicemailEnabled":false
}
}
]
}
}