Get Selective Call Forwarding Rule for a Hunt Group
Retrieve a Selective Call Forwarding Rule's settings for the designated Hunt Group.
A selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.
Note that the list of existing call forward rules is available in the hunt group's call forwarding settings.
Retrieving a selective call forwarding rule's 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.
NOTE: The Call Forwarding Rule ID will change upon modification of the Call Forwarding Rule name.
URI Parameters
Location in which this hunt group exists.
Retrieve settings for a rule for this hunt group.
Hunt group rule you are retrieving settings for.
Query Parameters
Retrieve hunt group rule settings for this organization.
Response Properties
Unique name for the selective rule in the hunt group.
Unique ID for the rule.
Reflects if rule is enabled.
Name of the location's holiday schedule which determines when this selective call forwarding rule is in effect.
Name of the location's business schedule which determines when this selective call forwarding rule is in effect.
Controls what happens when the rule matches including the destination number for the call forwarding.
Controls what happens when the rule matches.
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.
Phone number used if selection is FORWARD_TO_SPECIFIED_NUMBER.
Settings related to the rule matching based on incoming caller ID.
If CUSTOM, use customNumbers to specify which incoming caller ID values cause this rule to match. ANY means any incoming call matches assuming the rule is in effect based on the associated schedules.
Rule matches for calls from any number.
Rule matches based on the numbers and options in customNumbers.
Custom rules for matching incoming caller ID information.
Match if caller ID indicates the call is from a private number.
Match if caller ID is unavailable.
Array of number strings to be matched against incoming caller ID.
Settings related to the rule matching based on the destination number.
Array of numbers to be matched against the calling destination number.
Only return call queues with matching primary phone number or extension.
Primary phone extension of the call queue.
Type of
Indicates that the given phoneNumber or extension associated with this rule's containing object is a primary number or extension.
Indicates that the given phoneNumber or extension associated with this rule's containing object is an alternate number or extension.
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 rule settings for this organization.
{
"name": "My Rule",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WMmhsYmxSdg",
"enabled": true,
"businessSchedule": "BusiSched1",
"holidaySchedule": "HolSched1",
"forwardTo":
{
"selection": "FORWARD_TO_DEFAULT_NUMBER"},
"callsFrom":
{
"selection": "CUSTOM",
"customNumbers":
{
"privateNumberEnabled": true,
"unavailableNumberEnabled": true,
"numbers": ["2025551212"]
}
},
"callsTo": { "numbers": [] }
}