Get Call Forwarding Settings for a Hunt Group
Retrieve Call Forwarding settings for the specified Hunt Group including the list of call forwarding rules.
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.
Retrieving call forwarding settings for a hunt group requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Location in which this hunt group exists.
Read the call forwarding settings for this hunt group.
Query Parameters
Retrieve hunt group forwarding settings from this organization.
Response Properties
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.
Indicates enabled or disabled state of sending incoming calls to voicemail 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.
Indicates enabled or disabled state of sending incoming calls to voicemail 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.
Unique name of rule.
Comma-separated list of incoming call numbers that, when matched, will not be forwarded. A Limit of 12 numbers is allowed. Use Any private Number in the comma-separated value to indicate rules that match incoming calls from a private number. Use Any unavailable number in the comma-separated value to match incoming calls from an unavailable number.
Comma-separated list of the types of numbers being matched for incoming call destination.
Number to which calls will be forwarded if the rule is of type "Forward To" and the incoming call is matched.
Reflects if rule is enabled.
Settings related to operating modes.
Operating modes are enabled or disabled.
The ID of the current operating mode.
The exception type.
The mode was switched to or extended by the user for manual switch back and runs as an exception until the user manual switches the feature back to normal operation or a different mode.
The mode was switched to by the user before its start time and runs as an exception until its end time is reached at which point it automatically switches the feature back to normal operation.
The current mode was extended by the user before its end time and runs as an exception until the extension end time (mode's end time + extension of up to 12 hours) is reached at which point it automatically switches the feature back to normal operation.
The mode will remain the current operating mode for the feature until its normal end time is reached.
Operating modes.
Normal operation is enabled or disabled.
The ID of the operating mode.
The name of the operating mode.
The type of the operating mode.
The operating mode is not scheduled.
Single time duration for Monday-Friday and single time duration for Saturday-Sunday.
Individual time durations for every day of the week.
Holidays which have date durations spanning multiple days, as well as an optional yearly recurrence by day or date.
The level of the operating mode.
The operating mode is at the location level.
The operating mode is at the organization level.
Forward to settings.
The selection for forwarding.
When the rule matches, the mode's own default forwarding selection is to be applied.
When the rule matches, forward to the destination.
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.
The operating mode's destination.
The operating mode's destination voicemail enabled.
The operating mode's forward to selection.
When the rule matches, forward to the destination.
When the rule matches, do not forward to another number.
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
- Retrieve hunt group forwarding settings from this organization.
{
"callForwarding": {
"always": {
"enabled": false,
"ringReminderEnabled": false,
"destinationVoicemailEnabled": false
},
"selective": {
"enabled": false,
"destination": "00000",
"ringReminderEnabled": false,
"destinationVoicemailEnabled": false
},
"rules": [
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVXg",
"name": "testRule1",
"forwardTo": "65546",
"enabled": true
},
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVTA",
"name": "testRule4",
"forwardTo": "00000",
"enabled": true
}
],
"operatingModes":{
"enabled": "true",
"currentOperatingModeId": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"exceptionType":"MANUAL_SWITCH_BACK"
"modes": [
{
"normalOperationEnabled": true,
"id": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"name": "Normal Operation",
"type": "SAME_HOURS_DAILY,
"level": "LOCATION",
"forwardTo":{
"selection": "FORWARD_TO_SPECIFIED_NUMBER",
"destination": "00000",
"destinationVoicemailEnabled":false,
"defaultDestination":"00000",
"defaultDestinationVoicemailEnabled":false,
"defaultForwardToSelection":"DO_NOT_FORWARD",
}
}
]
}
}
}