APIs
Getting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Overview
Guides
Reference
Admin Audit EventsEventsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person SettingsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Devices
imiconnect
Meetings
Messaging
Webex Assistant Skills
Full API Reference
Admin Audit EventsAttachment ActionsBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesMessages with EditOrganizationsPeoplePlacesRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Person SettingsWebhooksWorkspace LocationsWorkspace MetricsWorkspacesxAPI
API Changelog

Get Details for a Hunt Group

Retrieve Hunt Group details.

Hunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group.

Retrieving hunt group details requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}
URI Parameters
locationId
stringrequired

Retrieve settings for a hunt group in this location.

huntGroupId
stringrequired

Retrieve settings for the hunt group with this identifier.

Query Parameters
orgId
string

Retrieve hunt group settings from this organization.

Response Properties
id
string

A unique identifier for the hunt group.

name
string

Unique name for the hunt group.

enabled
boolean

Whether or not the hunt group is enabled.

phoneNumber
string

Primary phone number of the hunt group.

extension
string

Extension of the hunt group.

distinctiveRing
boolean

Whether or not the hunt group has the distinctive ring option enabled.

alternateNumbers
array[AlternateNumbersWithPattern]

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.

phoneNumber
string

Alternate phone number for the hunt group.

ringPattern
RingPatternObject

Ring pattern for when this alternate number is called. Only available when distinctiveRing is enabled for the hunt group.

NORMAL
string

Normal incoming ring pattern.

LONG_LONG
string

Incoming ring pattern of two long rings.

SHORT_SHORT_LONG
string

Incoming ring pattern of two short rings, followed by a short ring.

SHORT_LONG_SHORT
string

Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.

language
string

Language for hunt group.

languageCode
string

Language code for hunt group.

firstName
string

First name to be shown when calls are forwarded out of this hunt group. Defaults to ".".

lastName
string

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.

timeZone
string

Time zone for the hunt group.

callPolicies
GetHuntGroupCallPolicyObject

Policy controlling how calls are routed to agents.

policy
HuntPolicySelection

Call routing policy to use to dispatch calls to agents.

CIRCULAR
string

(Max 1,000 agents) This option cycles through all agents after the last agent that took a call. It sends calls to the next available agent.

REGULAR
string

(Max 1,000 agents) Send the call through the queue of agents in order, starting from the top each time.

SIMULTANEOUS
string

(Max 50 agents) Sends calls to all agents at once

UNIFORM
string

(Max 1,000 agents) 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.

WEIGHTED
string

(Max 100 agents) Sends call to idle agents based on percentages you assign to each agent (up to 100%).

waitingEnabled
boolean

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 will advance to the next agent. If a hunt group agent has call waiting enabled and the call is advanced to them, then the call will wait until that hunt group agent isn’t busy.

noAnswer
object

Settings for when the call into the hunt group is not answered.

nextAgentEnabled
boolean

If enabled, advance to next agent after the nextAgentRings has occurred.

nextAgentRings
number

Number of rings before call will be forwarded if unanswered and nextAgentEnabled is true.

forwardEnabled
boolean

If true, forwards unanswered calls to the destination after the number of rings occurs.

destination
string

Destination if forwardEnabled is True.

numberOfRings
number

Number of rings before forwarding calls if forwardEnabled is true.

systemMaxNumberOfRings
number

System-wide maximum number of rings allowed for numberOfRings setting.

destinationVoicemailEnabled
boolean

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.

businessContinuity
object

Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem.

enabled
boolean

Divert calls when unreachable, unanswered calls divert to a defined phone number. This could apply to phone calls that aren't answered due to a network outage, or all agents of the hunt group are busy and the Advance when the busy option is also enabled. For persons only using a mobile device, calls won't be diverted, if there is a network outage.

destination
string

Destination for Business Continuity.

destinationVoicemailEnabled
boolean

Indicates 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.

agents
array[GetPersonPlaceObject]

People, including workspaces, that are eligible to receive calls.

id
string

ID of person or workspace.

firstName
string

First name of person or workspace.

lastName
string

First name of person or workspace.

phoneNumber
string

Phone number of person or workspace.

extension
string

Extension of person or workspace.

weight
string

Weight of person or workspace. Only applied when call policy is WEIGHTED.

enabled
boolean

Whether or not the hunt group is enabled.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/telephony/config/locations//huntGroups//huntGroups/{?orgId}
Log in to try the API.
Header
Query Parameters
  • Retrieve hunt group settings from this organization.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx/huntGroups/Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
"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,
    "noAnswer": {
        "nextAgentEnabled": false,
        "nextAgentRings": 5,
        "forwardEnabled": false,
        "numberOfRings": 0,
        "systemMaxNumberOfRing": 20,
        "destinationVoicemailEnabled": false
    },
    "businessContinuity": {
        "enabled": false,
        "destinationVoicemailEnabled": false
    }
},
"agents": [
    {
        "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YTUwMDk1YS1mZjlmLTExZWItODA2NS04ZjhkOWIxNmIzOTQ",
        "firstName": "Amithuser1",
        "lastName": "testUser",
        "phoneNumber": "+441234222343",
        "extension": "2145"
    },
    {
        "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc1MWQ",
        "firstName": ".",
        "lastName": "rod.morehead",
        "phoneNumber": "9729994703",
        "extension": "1344"
    }]
}