Webex APIs
OverviewBasicsComplianceHybrid ServicesAPI Changelog
Full API reference
Admin Audit Events Attachment Actions BroadWorks Enterprises BroadWorks Subscribers Call Controls Device Configurations Devices Events Historical Analytics Hybrid Clusters Hybrid Connectors Licenses Locations Meeting Invitees Meeting Participants Meeting Preferences Meeting Qualities Meeting Transcripts Meetings Memberships Messages Organizations People Places Recordings Report Templates Reports Resource Group Memberships Resource Groups Roles Room Tabs Rooms Space Classifications Team Memberships Teams Webex Calling Organization Settings Webex Calling Person Settings Webhooks Workspace Metrics Workspaces xAPI

Create a Hunt Group

Creates new Hunt Groups for the given location.

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.

Creating a hunt group requires a full or user administrator auth token with a scope of spark-admin:telephony_config_write.

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

Create the hunt group for the given location.

Query Parameters
orgId
string

Create the hunt group for this organization.

Body Parameters
name
stringrequired

Unique name for the hunt group.

phoneNumber
string

Primary phone number of the hunt group.

extension
string

Primary phone extension of the hunt group.

languageCode
string

Language code.

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 the phone number if set, otherwise defaults to call group name.

timeZone
string

Time zone for the hunt group.

callPolicies
PostHuntGroupCallPolicyObjectrequired

Policy controlling how calls are routed to agents.

policy
HuntPolicySelectionrequired

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
objectrequired

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

nextAgentEnabled
booleanrequired

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

nextAgentRings
numberrequired

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

forwardEnabled
booleanrequired

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

numberOfRings
numberrequired

Number of rings before forwarding calls if forwardEnabled is true.

destination
string

Destination if forwardEnabled is True.

destinationVoicemailEnabled
booleanrequired

If forwardEnabled 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
objectrequired

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
booleanrequired

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
booleanrequired

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
arrayrequired

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

id
stringrequired

ID of person or workspace.

weight
string

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

enabled
booleanrequired

Whether or not the hunt group is enabled.

Response Properties
id
string

ID of the newly created hunt group.

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.
POST
/v1/telephony/config/locations//huntGroups{?orgId}
Log in to try the API.
Header
Query Parameters
  • Create the hunt group for this organization.
Body
  • Unique name for the hunt group.
  • Primary phone number of the hunt group.
  • Primary phone extension of the hunt group.
  • Language code.
  • 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 the phone number if set, otherwise defaults to call group name.
  • Time zone for the hunt group.
  • Policy controlling how calls are routed to agents.
  • People, including workspaces, that are eligible to receive calls.
  • Whether or not the hunt group is enabled.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA/huntGroups?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
    "name": "5714328359",
    "phoneNumber": "5558675309",
    "extension": "7781",
    "firstName": "Hakim",
    "lastName": "Smith",
    "callPolicies": {
        "policy": "UNIFORM",
        "waitingEnabled": false,
        "noAnswer": {
             "nextAgentEnabled": false,
             "nextAgentRings": 5,
             "forwardEnabled": false,
             "numberOfRings": 0,
             "destinationVoicemailEnabled": false
             },
        "businessContinuity": {
            "enabled": false,
            "destinationVoicemailEnabled": false
            }
        },
    "agents": [
        {"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI"},
        {"id": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzU1YjUyZThhLWZmOWYtMTFlYi05ZjRhLTAzZDY1NzdhYzg1Yg"}]
    "enabled": true
}
200 / OK
{
    "id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0"
}