Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Features: Hunt Group API

The Features: Hunt Group API from Webex — 10 operation(s) for features: hunt group.

Webex Features: Hunt Group API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Features: Hunt Group. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 10 paths, and defines 33 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

15 operations 10 paths 33 schemas 2 DELETE7 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Features: Hunt Group API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 2 DELETE, 7 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Features: Hunt Group 15
GET
/telephony/config/huntGroups
Read the List of Hunt Groups
listHuntGroups 6 params → 200400401403404405409410
POST
/telephony/config/locations/{locationId}/huntGroups
Create a Hunt Group
createHuntGroup 2 params body → 200400401403404405409410
DELETE
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}
Delete a Hunt Group
deleteHuntGroup 3 params → 204400401403404405409410
GET
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}
Get Details for a Hunt Group
getHuntGroup 3 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}
Update a Hunt Group
updateHuntGroup 3 params body → 204400401403404405409410
GET
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding
Get Call Forwarding Settings for a Hunt Group
getHuntGroupCallForwardingSettings 3 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding
Update Call Forwarding Settings for a Hunt Group
updateHuntGroupCallForwardingSettings 3 params body → 204400401403404405409410
POST
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding/selectiveRules
Create a Selective Call Forwarding Rule for a Hunt Group
createHuntGroupSelectiveCallForwardingRule 3 params body → 201400401403404405409410
GET
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding/selectiveRules/{ruleId}
Get Selective Call Forwarding Rule for a Hunt Group
getHuntGroupSelectiveCallForwardingRule 4 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding/selectiveRules/{ruleId}
Update a Selective Call Forwarding Rule for a Hunt Group
updateHuntGroupSelectiveCallForwardingRule 4 params body → 201400401403404405409410
DELETE
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding/selectiveRules/{ruleId}
Delete a Selective Call Forwarding Rule for a Hunt Group
deleteHuntGroupSelectiveCallForwardingRule 4 params → 204400401403404405409410
GET
/telephony/config/locations/{locationId}/huntGroups/availableNumbers
Get Hunt Group Primary Available Phone Numbers
getHuntGroupPrimaryAvailablePhoneNumbers 5 params → 200400401403404405409410
GET
/telephony/config/locations/{locationId}/huntGroups/alternate/availableNumbers
Get Hunt Group Alternate Available Phone Numbers
getHuntGroupAlternateAvailablePhoneNumbers 5 params → 200400401403404405409410
GET
/telephony/config/locations/{locationId}/huntGroups/callForwarding/availableNumbers
Get Hunt Group Call Forward Available Phone Numbers
getHuntGroupCallForwardAvailablePhoneNumbers 7 params → 200400401403404405409410
POST
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding/actions/switchMode/invoke
Switch Mode for Call Forwarding Settings for a Hunt Group
switchHuntGroupCallForwardingMode 3 params body → 204400401403404405409410

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are GetHuntGroupObject (17 properties), ModifyHuntGroupObject (15 properties), CreateHuntGroupObject (13 properties), ListHuntGroupObject (9 properties). Each schema is shown below with its type and property counts.

HuntGroupAlternateAvailableNumberListGetObject
object
1 property 1 required
NumberOwnerType
string
PLACE - PSTN phone number's owner is a workspace. PEOPLE - PSTN phone number's owner is a person. VIRTUALLINE - PSTN phone number's owner is a Virtual Profile.…
PostPersonPlaceVirtualLineHuntGroupObject
object
2 properties 1 required
ModesGet
object
6 properties 6 required
DirectLineCallerIdNameObject
object
Settings for the direct line caller ID name to be shown for this workspace.
2 properties
GetPersonPlaceVirtualLineHuntGroupObject
object
8 properties 1 required
CallForwardSettingsGet
object
1 property 1 required
PostHuntGroupCallPolicyObject
object
7 properties 2 required
HuntGroupAlternateAvailableNumberObject
object
6 properties 6 required
CallForwardRulesGet
object
6 properties 1 required
ListHuntGroupObject
object
9 properties 5 required
HuntGroupCallForwardAvailableNumberListGetObject
object
1 property 1 required
GetHuntGroupObject
object
17 properties 7 required
HuntGroupCallForwardAvailableNumberObject
object
8 properties 5 required
GetHuntGroupCallPolicyObject
object
7 properties 2 required
ModifyHuntGroupObject
object
15 properties
ModesPatch
object
3 properties 3 required
SelectionObject
string
DISPLAYNAME - When this option is selected, displayName is to be shown for this workspace. CUSTOMNAME - When this option is selected, customName is to be shown…
HuntGroupPrimaryAvailableNumberListGetObject
object
1 property 1 required
ModifyCallForwardingObject
object
1 property
STATE
string
ACTIVE - Phone number is in the active state. INACTIVE - Phone number is in the inactive state.
HuntGroupPrimaryAvailableNumberObject
object
6 properties 6 required
AlternateNumbersWithPattern
object
2 properties 1 required
GetForwardingRuleObject
object
8 properties 4 required
HuntPolicySelection
string
CIRCULAR - 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…
CallForwardRulesSet
object
2 properties 1 required
CreateForwardingRuleObject
object
7 properties 3 required
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
DirectLineCallerIdNameObjectForPut
object
Settings for the direct line caller ID name to be shown for this workspace.
2 properties
ModifyForwardingRuleObject
object
7 properties
CreateHuntGroupObject
object
13 properties 4 required
RingPatternObject
string
NORMAL - Normal incoming ring pattern. LONGLONG - Incoming ring pattern of two long rings. SHORTSHORTLONG - Incoming ring pattern of two short rings, followed…
CallForwardingNumbers
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-features-hunt-group-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API