Get Details for a Hunt Group
Retrieve Hunt Group details.
Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.
Retrieving hunt group details requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve settings for a hunt group in this location.
Retrieve settings for the hunt group with this identifier.
Query Parameters
Retrieve hunt group settings from this organization.
Response Properties
A unique identifier for the hunt group.
Unique name for the hunt group.
Whether or not the hunt group is enabled.
Primary phone number of the hunt group.
Extension of the hunt group.
Whether or not the hunt group has the distinctive ring option enabled.
The alternate numbers feature allows you to assign multiple phone numbers or extensions to a hunt group. Each number will reach the same greeting and each menu will function identically to the main number. The alternate numbers option enables you to have up to ten (10) phone numbers ring into the hunt group.
Alternate phone number for the hunt group.
Ring pattern for when this alternate number is called. Only available when distinctiveRing is enabled for the hunt group.
Normal incoming ring pattern.
Incoming ring pattern of two long rings.
Incoming ring pattern of two short rings, followed by a short ring.
Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.
Language for hunt group.
Language code for hunt group.
First name to be shown when calls are forwarded out of this hunt group. Defaults to ..
Last name to be shown when calls are forwarded out of this hunt group. Defaults to phone number if set, otherwise defaults to call group name.
Time zone for the hunt group.
Policy controlling how calls are routed to agents.
Call routing policy used to dispatch calls to agents.
This option cycles through all agents after the last agent that took a call. It sends calls to the next available agent. This is supported for SKILL_BASED.
Send the call through the queue of agents in order, starting from the top each time. This is supported for SKILL_BASED.
Sends calls to all agents at once
Sends calls to the agent that has been idle the longest. If they don't answer, proceed to the next agent who has been idle the second longest, and so on until the call is answered. This is supported for SKILL_BASED.
Sends calls to idle agents based on percentages you assign to each agent (up to 100%).
If false, then the option is treated as "Advance when busy". The hunt group won't ring agents when they're on a call and advances to the next agent. If a hunt group agent has call waiting enabled and the call is advanced to them, the call waits until that hunt group agent isn't busy.
When true, the hunt group busy status will be set to busy. All new calls will get busy treatment. If busyRedirect is enabled, the calls are routed to the destination specified in busyRedirect.
When true, agents can change the hunt group busy status.
Settings for when the call into the hunt group is not answered.
If enabled, advance to next agent after the nextAgentRings has occurred.
Number of rings before call will be forwarded if unanswered and nextAgentEnabled is true.
If true, forwards unanswered calls to the destination after the number of rings occurs.
Destination if forwardEnabled is True.
Number of rings before forwarding calls if forwardEnabled is true.
System-wide maximum number of rings allowed for numberOfRings setting.
If destinationVoicemailEnabled is true, enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled.
Settings for sending calls to a specified destination when all agents are busy or when the hunt group busy status is set to busy.
If true, calls are diverted to a defined phone number when all agents are busy, or when the hunt group busy status is set to busy.
Destination for busy redirect.
The enabled or disabled state of sending diverted incoming calls to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled.
Settings for sending calls to a specified destination if the phone is not connected to the network for any reason, such as a power outage, failed internet connection, or wiring problem.
If true, unreachable, unanswered calls are diverted to a defined phone number. For persons with only a mobile device, calls won't be diverted if there is a network outage.
Destination for business continuity redirect.
The enabled or disabled state of sending diverted incoming calls to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled.
People, workspaces and virtual lines that are eligible to receive calls.
ID of person, workspace or virtual line.
First name of person, workspace or virtual line.
Last name of person, workspace or virtual line.
Phone number of person, workspace or virtual line.
Extension of person, workspace or virtual line.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
Weight of person, workspace or virtual line. Only applied when call policy is WEIGHTED.
Whether or not the hunt group is enabled.
Whether or not the hunt group can be used as the caller ID when the agent places outgoing calls.
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 settings from this organization.
{
"id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"name": "hgnME3",
"enabled": true,
"extension": "079999",
"distinctiveRing": true,
"alternateNumbers": [],
"language": "English",
"languageCode": "en-US",
"callingFirstName": ".",
"callingLastName": "hgnME3",
"timeZone": "America/Los_Angeles",
"callPolicies": {
"policy": "UNIFORM",
"waitingEnabled": false,
"groupBusyEnabled": true,
"allowMembersToControlGroupBusyEnabled": true,
"noAnswer": {
"nextAgentEnabled": false,
"nextAgentRings": 5,
"forwardEnabled": false,
"numberOfRings": 0,
"systemMaxNumberOfRing": 20,
"destinationVoicemailEnabled": false
},
"busyRedirect": {
"enabled": true,
"destination": "7037344404",
"destinationVoicemailEnabled": true
},
"businessContinuityRedirect": {
"enabled": true,
"destination": "7037344405",
"destinationVoicemailEnabled": false
}
},
"agents": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI",
"firstName": "John",
"lastName": "Doe",
"type": "PEOPLE",
"phoneNumber": "+15558675310",
"extension": "7781",
"routingPrefix": "123",
"esn": "1237781"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ",
"firstName": "Alaska Office",
"lastName": "Second Floor",
"type": "PLACE",
"phoneNumber": "+15558675311",
"extension": "7781",
"routingPrefix": "123",
"esn": "1237781"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg=",
"firstName": "Alice",
"lastName": "Smith",
"type": "VIRTUAL_LINE",
"phoneNumber": "+15558675311",
"extension": "7782",
"routingPrefix": "123",
"esn": "1237781"
}],
"huntGroupCallerIdForOutgoingCallsEnabled": true
}